[Python-checkins] Regenerate topics file (GH-13642)

Pablo Galindo webhook-mailer at python.org
Wed May 29 17:59:04 EDT 2019


https://github.com/python/cpython/commit/29cb21ddb92413931e473eb799a02e2d8cdf4a45
commit: 29cb21ddb92413931e473eb799a02e2d8cdf4a45
branch: master
author: Pablo Galindo <Pablogsal at gmail.com>
committer: GitHub <noreply at github.com>
date: 2019-05-29T22:59:00+01:00
summary:

Regenerate topics file (GH-13642)

files:
M Doc/reference/compound_stmts.rst
M Lib/pydoc_data/topics.py

diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index bf53cb5a48ab..988eec6d254e 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -483,7 +483,7 @@ A function definition defines a user-defined function object (see section
    decorators: `decorator`+
    decorator: "@" `dotted_name` ["(" [`argument_list` [","]] ")"] NEWLINE
    dotted_name: `identifier` ("." `identifier`)*
-   parameter_list: `defparameter` ("," `defparameter`)* ',' '/' [',' [`parameter_list_no_posonly`]]
+   parameter_list: `defparameter` ("," `defparameter`)* "," "/" ["," [`parameter_list_no_posonly`]]
                  :   | `parameter_list_no_posonly`
    parameter_list_no_posonly: `defparameter` ("," `defparameter`)* ["," [`parameter_list_starargs`]]
                             : | `parameter_list_starargs`
diff --git a/Lib/pydoc_data/topics.py b/Lib/pydoc_data/topics.py
index 875d6e890347..3361c6b5568a 100644
--- a/Lib/pydoc_data/topics.py
+++ b/Lib/pydoc_data/topics.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Autogenerated by Sphinx on Mon May  6 20:27:55 2019
+# Autogenerated by Sphinx on Wed May 29 01:18:52 2019
 topics = {'assert': 'The "assert" statement\n'
            '**********************\n'
            '\n'
@@ -2044,7 +2044,7 @@
                 'exception is raised, it is as if "in" raised that '
                 'exception).\n'
                 '\n'
-                'The operator "not in" is defined to have the inverse true '
+                'The operator "not in" is defined to have the inverse truth '
                 'value of\n'
                 '"in".\n'
                 '\n'
@@ -2052,13 +2052,13 @@
                 'Identity comparisons\n'
                 '====================\n'
                 '\n'
-                'The operators "is" and "is not" test for object identity: "x '
-                'is y" is\n'
-                'true if and only if *x* and *y* are the same object.  Object '
-                'identity\n'
-                'is determined using the "id()" function.  "x is not y" yields '
-                'the\n'
-                'inverse truth value. [4]\n',
+                'The operators "is" and "is not" test for an object’s '
+                'identity: "x is\n'
+                'y" is true if and only if *x* and *y* are the same object.  '
+                'An\n'
+                'Object’s identity is determined using the "id()" function.  '
+                '"x is not\n'
+                'y" yields the inverse truth value. [4]\n',
  'compound': 'Compound statements\n'
              '*******************\n'
              '\n'
@@ -2558,22 +2558,25 @@
              '(see\n'
              'section The standard type hierarchy):\n'
              '\n'
-             '   funcdef                 ::= [decorators] "def" funcname "(" '
+             '   funcdef                   ::= [decorators] "def" funcname "(" '
              '[parameter_list] ")"\n'
              '               ["->" expression] ":" suite\n'
-             '   decorators              ::= decorator+\n'
-             '   decorator               ::= "@" dotted_name ["(" '
+             '   decorators                ::= decorator+\n'
+             '   decorator                 ::= "@" dotted_name ["(" '
              '[argument_list [","]] ")"] NEWLINE\n'
-             '   dotted_name             ::= identifier ("." identifier)*\n'
-             '   parameter_list          ::= defparameter ("," defparameter)* '
-             '["," [parameter_list_starargs]]\n'
-             '                      | parameter_list_starargs\n'
-             '   parameter_list_starargs ::= "*" [parameter] ("," '
+             '   dotted_name               ::= identifier ("." identifier)*\n'
+             '   parameter_list            ::= defparameter ("," '
+             'defparameter)* "," "/" ["," [parameter_list_no_posonly]]\n'
+             '                        | parameter_list_no_posonly\n'
+             '   parameter_list_no_posonly ::= defparameter ("," '
+             'defparameter)* ["," [parameter_list_starargs]]\n'
+             '                                 | parameter_list_starargs\n'
+             '   parameter_list_starargs   ::= "*" [parameter] ("," '
              'defparameter)* ["," ["**" parameter [","]]]\n'
              '                               | "**" parameter [","]\n'
-             '   parameter               ::= identifier [":" expression]\n'
-             '   defparameter            ::= parameter ["=" expression]\n'
-             '   funcname                ::= identifier\n'
+             '   parameter                 ::= identifier [":" expression]\n'
+             '   defparameter              ::= parameter ["=" expression]\n'
+             '   funcname                  ::= identifier\n'
              '\n'
              'A function definition is an executable statement.  Its execution '
              'binds\n'
@@ -4363,7 +4366,7 @@
                'terminates\n'
                'execution of the program, or returns to its interactive main '
                'loop.  In\n'
-               'either case, it prints a stack backtrace, except when the '
+               'either case, it prints a stack traceback, except when the '
                'exception is\n'
                '"SystemExit".\n'
                '\n'
@@ -4684,7 +4687,7 @@
               'terminates\n'
               'execution of the program, or returns to its interactive main '
               'loop.  In\n'
-              'either case, it prints a stack backtrace, except when the '
+              'either case, it prints a stack traceback, except when the '
               'exception is\n'
               '"SystemExit".\n'
               '\n'
@@ -5078,7 +5081,7 @@
                   'Meaning                                                    '
                   '|\n'
                   '   '
-                  '+===========+============================================================+\n'
+                  '|===========|============================================================|\n'
                   '   | "\'<\'"     | Forces the field to be left-aligned '
                   'within the available   |\n'
                   '   |           | space (this is the default for most '
@@ -5127,7 +5130,7 @@
                   'Meaning                                                    '
                   '|\n'
                   '   '
-                  '+===========+============================================================+\n'
+                  '|===========|============================================================|\n'
                   '   | "\'+\'"     | indicates that a sign should be used for '
                   'both positive as  |\n'
                   '   |           | well as negative '
@@ -5231,7 +5234,7 @@
                   'Meaning                                                    '
                   '|\n'
                   '   '
-                  '+===========+============================================================+\n'
+                  '|===========|============================================================|\n'
                   '   | "\'s\'"     | String format. This is the default type '
                   'for strings and    |\n'
                   '   |           | may be '
@@ -5251,7 +5254,7 @@
                   'Meaning                                                    '
                   '|\n'
                   '   '
-                  '+===========+============================================================+\n'
+                  '|===========|============================================================|\n'
                   '   | "\'b\'"     | Binary format. Outputs the number in '
                   'base 2.               |\n'
                   '   '
@@ -5313,7 +5316,7 @@
                   'Meaning                                                    '
                   '|\n'
                   '   '
-                  '+===========+============================================================+\n'
+                  '|===========|============================================================|\n'
                   '   | "\'e\'"     | Exponent notation. Prints the number in '
                   'scientific         |\n'
                   '   |           | notation using the letter ‘e’ to indicate '
@@ -5584,22 +5587,25 @@
              '(see\n'
              'section The standard type hierarchy):\n'
              '\n'
-             '   funcdef                 ::= [decorators] "def" funcname "(" '
+             '   funcdef                   ::= [decorators] "def" funcname "(" '
              '[parameter_list] ")"\n'
              '               ["->" expression] ":" suite\n'
-             '   decorators              ::= decorator+\n'
-             '   decorator               ::= "@" dotted_name ["(" '
+             '   decorators                ::= decorator+\n'
+             '   decorator                 ::= "@" dotted_name ["(" '
              '[argument_list [","]] ")"] NEWLINE\n'
-             '   dotted_name             ::= identifier ("." identifier)*\n'
-             '   parameter_list          ::= defparameter ("," defparameter)* '
-             '["," [parameter_list_starargs]]\n'
-             '                      | parameter_list_starargs\n'
-             '   parameter_list_starargs ::= "*" [parameter] ("," '
+             '   dotted_name               ::= identifier ("." identifier)*\n'
+             '   parameter_list            ::= defparameter ("," '
+             'defparameter)* "," "/" ["," [parameter_list_no_posonly]]\n'
+             '                        | parameter_list_no_posonly\n'
+             '   parameter_list_no_posonly ::= defparameter ("," '
+             'defparameter)* ["," [parameter_list_starargs]]\n'
+             '                                 | parameter_list_starargs\n'
+             '   parameter_list_starargs   ::= "*" [parameter] ("," '
              'defparameter)* ["," ["**" parameter [","]]]\n'
              '                               | "**" parameter [","]\n'
-             '   parameter               ::= identifier [":" expression]\n'
-             '   defparameter            ::= parameter ["=" expression]\n'
-             '   funcname                ::= identifier\n'
+             '   parameter                 ::= identifier [":" expression]\n'
+             '   defparameter              ::= parameter ["=" expression]\n'
+             '   funcname                  ::= identifier\n'
              '\n'
              'A function definition is an executable statement.  Its execution '
              'binds\n'
@@ -6338,7 +6344,7 @@
        'integer indices do not raise "IndexError" exception.  (If any other\n'
        'exception is raised, it is as if "in" raised that exception).\n'
        '\n'
-       'The operator "not in" is defined to have the inverse true value of\n'
+       'The operator "not in" is defined to have the inverse truth value of\n'
        '"in".\n',
  'integers': 'Integer literals\n'
              '****************\n'
@@ -7019,7 +7025,7 @@
                      '+-------------------------------------------------+---------------------------------------+\n'
                      '| Operator                                        | '
                      'Description                           |\n'
-                     '+=================================================+=======================================+\n'
+                     '|=================================================|=======================================|\n'
                      '| "lambda"                                        | '
                      'Lambda expression                     |\n'
                      '+-------------------------------------------------+---------------------------------------+\n'
@@ -10263,7 +10269,7 @@
                    '   | Representation          | '
                    'Description                   |\n'
                    '   '
-                   '+=========================+===============================+\n'
+                   '|=========================|===============================|\n'
                    '   | "\\n"                    | Line '
                    'Feed                     |\n'
                    '   '
@@ -10602,7 +10608,7 @@
             '+-------------------+-----------------------------------+---------+\n'
             '| Escape Sequence   | Meaning                           | Notes   '
             '|\n'
-            '+===================+===================================+=========+\n'
+            '|===================|===================================|=========|\n'
             '| "\\newline"        | Backslash and newline ignored     '
             '|         |\n'
             '+-------------------+-----------------------------------+---------+\n'
@@ -10648,7 +10654,7 @@
             '+-------------------+-----------------------------------+---------+\n'
             '| Escape Sequence   | Meaning                           | Notes   '
             '|\n'
-            '+===================+===================================+=========+\n'
+            '|===================|===================================|=========|\n'
             '| "\\N{name}"        | Character named *name* in the     | '
             '(4)     |\n'
             '|                   | Unicode database                  |         '
@@ -11286,7 +11292,7 @@
           '      | Attribute                 | Meaning                         '
           '|             |\n'
           '      '
-          '+===========================+=================================+=============+\n'
+          '|===========================|=================================|=============|\n'
           '      | "__doc__"                 | The function’s documentation    '
           '| Writable    |\n'
           '      |                           | string, or "None" if            '
@@ -12557,7 +12563,7 @@
              '+----------------------------+----------------------------------+------------+\n'
              '| Operation                  | Result                           '
              '| Notes      |\n'
-             '+============================+==================================+============+\n'
+             '|============================|==================================|============|\n'
              '| "x in s"                   | "True" if an item of *s* is      '
              '| (1)        |\n'
              '|                            | equal to *x*, else "False"       '
@@ -12786,7 +12792,7 @@
              '+--------------------------------+----------------------------------+-----------------------+\n'
              '| Operation                      | '
              'Result                           | Notes                 |\n'
-             '+================================+==================================+=======================+\n'
+             '|================================|==================================|=======================|\n'
              '| "s[i] = x"                     | item *i* of *s* is replaced '
              'by   |                       |\n'
              '|                                | '
@@ -12872,7 +12878,7 @@
              'default\n'
              '   the last item is removed and returned.\n'
              '\n'
-             '3. "remove" raises "ValueError" when *x* is not found in *s*.\n'
+             '3. "remove()" raises "ValueError" when *x* is not found in *s*.\n'
              '\n'
              '4. The "reverse()" method modifies the sequence in place for\n'
              '   economy of space when reversing a large sequence.  To remind '
@@ -12883,7 +12889,11 @@
              '\n'
              '5. "clear()" and "copy()" are included for consistency with the\n'
              '   interfaces of mutable containers that don’t support slicing\n'
-             '   operations (such as "dict" and "set")\n'
+             '   operations (such as "dict" and "set"). "copy()" is not part '
+             'of the\n'
+             '   "collections.abc.MutableSequence" ABC, but most concrete '
+             'mutable\n'
+             '   sequence classes provide it.\n'
              '\n'
              '   New in version 3.3: "clear()" and "copy()" methods.\n'
              '\n'
@@ -13244,7 +13254,7 @@
                      '| Operation                      | '
                      'Result                           | Notes                 '
                      '|\n'
-                     '+================================+==================================+=======================+\n'
+                     '|================================|==================================|=======================|\n'
                      '| "s[i] = x"                     | item *i* of *s* is '
                      'replaced by   |                       |\n'
                      '|                                | '
@@ -13333,8 +13343,8 @@
                      'by default\n'
                      '   the last item is removed and returned.\n'
                      '\n'
-                     '3. "remove" raises "ValueError" when *x* is not found in '
-                     '*s*.\n'
+                     '3. "remove()" raises "ValueError" when *x* is not found '
+                     'in *s*.\n'
                      '\n'
                      '4. The "reverse()" method modifies the sequence in place '
                      'for\n'
@@ -13348,7 +13358,11 @@
                      'with the\n'
                      '   interfaces of mutable containers that don’t support '
                      'slicing\n'
-                     '   operations (such as "dict" and "set")\n'
+                     '   operations (such as "dict" and "set"). "copy()" is '
+                     'not part of the\n'
+                     '   "collections.abc.MutableSequence" ABC, but most '
+                     'concrete mutable\n'
+                     '   sequence classes provide it.\n'
                      '\n'
                      '   New in version 3.3: "clear()" and "copy()" methods.\n'
                      '\n'



More information about the Python-checkins mailing list