[Python-checkins] bpo-33702: Add some missing links in production lists and do a little polish (GH-7259)

Sat Jul 7 17:09:23 EDT 2018

https://github.com/python/cpython/commit/445f9edaa4efbf76ae0fe8e18707665ac16dd5a4
commit: 445f9edaa4efbf76ae0fe8e18707665ac16dd5a4
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018年07月07日T14:09:20-07:00
summary:
bpo-33702: Add some missing links in production lists and do a little polish (GH-7259)
(cherry picked from commit caccca78e46bf3c3b24e09b3afb1c1b08c39990c)
Co-authored-by: Andrés Delfino <adelfino at gmail.com>
files:
M Doc/reference/compound_stmts.rst
M Doc/reference/expressions.rst
M Doc/reference/simple_stmts.rst

diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index dca936240045..be6fc9708c86 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -91,7 +91,7 @@ The :keyword:`if` statement is used for conditional execution:
 
 .. productionlist::
 if_stmt: "if" `expression` ":" `suite`
- : ( "elif" `expression` ":" `suite` )*
+ : ("elif" `expression` ":" `suite`)*
 : ["else" ":" `suite`]
 
 It selects exactly one of the suites by evaluating the expressions one by one
@@ -235,7 +235,7 @@ The :keyword:`try` statement specifies exception handlers and/or cleanup code
 for a group of statements:
 
 .. productionlist::
- try_stmt: try1_stmt | try2_stmt
+ try_stmt: `try1_stmt` | `try2_stmt`
 try1_stmt: "try" ":" `suite`
 : ("except" [`expression` ["as" `identifier`]] ":" `suite`)+
 : ["else" ":" `suite`]
@@ -383,7 +383,7 @@ This allows common :keyword:`try`...\ :keyword:`except`...\ :keyword:`finally`
 usage patterns to be encapsulated for convenient reuse.
 
 .. productionlist::
- with_stmt: "with" with_item ("," with_item)* ":" `suite`
+ with_stmt: "with" `with_item` ("," `with_item`)* ":" `suite`
 with_item: `expression` ["as" `target`]
 
 The execution of the :keyword:`with` statement with one "item" proceeds as follows:
@@ -467,14 +467,15 @@ A function definition defines a user-defined function object (see section
 :ref:`types`):
 
 .. productionlist::
- funcdef: [`decorators`] "def" `funcname` "(" [`parameter_list`] ")" ["->" `expression`] ":" `suite`
+ funcdef: [`decorators`] "def" `funcname` "(" [`parameter_list`] ")"
+ : ["->" `expression`] ":" `suite`
 decorators: `decorator`+
 decorator: "@" `dotted_name` ["(" [`argument_list` [","]] ")"] NEWLINE
 dotted_name: `identifier` ("." `identifier`)*
 parameter_list: `defparameter` ("," `defparameter`)* ["," [`parameter_list_starargs`]]
 : | `parameter_list_starargs`
 parameter_list_starargs: "*" [`parameter`] ("," `defparameter`)* ["," ["**" `parameter` [","]]]
- : | "**" `parameter` [","]
+ : | "**" `parameter` [","]
 parameter: `identifier` [":" `expression`]
 defparameter: `parameter` ["=" `expression`]
 funcname: `identifier`
@@ -682,7 +683,8 @@ Coroutine function definition
 -----------------------------
 
 .. productionlist::
- async_funcdef: [`decorators`] "async" "def" `funcname` "(" [`parameter_list`] ")" ["->" `expression`] ":" `suite`
+ async_funcdef: [`decorators`] "async" "def" `funcname` "(" [`parameter_list`] ")"
+ : ["->" `expression`] ":" `suite`
 
 .. index::
 keyword: async
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index c1f2fab6c51c..3f929bf09287 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -1013,7 +1013,7 @@ The power operator binds more tightly than unary operators on its left; it binds
 less tightly than unary operators on its right. The syntax is:
 
 .. productionlist::
- power: ( `await_expr` | `primary` ) ["**" `u_expr`]
+ power: (`await_expr` | `primary`) ["**" `u_expr`]
 
 Thus, in an unparenthesized sequence of power and unary operators, the operators
 are evaluated from right to left (this does not constrain the evaluation order
@@ -1085,7 +1085,7 @@ operators and one for additive operators:
 
 .. productionlist::
 m_expr: `u_expr` | `m_expr` "*" `u_expr` | `m_expr` "@" `m_expr` |
- : `m_expr` "//" `u_expr`| `m_expr` "/" `u_expr` |
+ : `m_expr` "//" `u_expr` | `m_expr` "/" `u_expr` |
 : `m_expr` "%" `u_expr`
 a_expr: `m_expr` | `a_expr` "+" `m_expr` | `a_expr` "-" `m_expr`
 
@@ -1165,7 +1165,7 @@ Shifting operations
 The shifting operations have lower priority than the arithmetic operations:
 
 .. productionlist::
- shift_expr: `a_expr` | `shift_expr` ( "<<" | ">>" ) `a_expr`
+ shift_expr: `a_expr` | `shift_expr` ("<<" | ">>") `a_expr`
 
 These operators accept integers as arguments. They shift the first argument to
 the left or right by the number of bits given by the second argument.
@@ -1230,7 +1230,7 @@ C, expressions like ``a < b < c`` have the interpretation that is conventional
 in mathematics:
 
 .. productionlist::
- comparison: `or_expr` ( `comp_operator` `or_expr` )*
+ comparison: `or_expr` (`comp_operator` `or_expr`)*
 comp_operator: "<" | ">" | "==" | ">=" | "<=" | "!="
 : | "is" ["not"] | ["not"] "in"
 
@@ -1594,9 +1594,9 @@ Expression lists
 .. index:: pair: expression; list
 
 .. productionlist::
- expression_list: `expression` ( "," `expression` )* [","]
- starred_list: `starred_item` ( "," `starred_item` )* [","]
- starred_expression: `expression` | ( `starred_item` "," )* [`starred_item`]
+ expression_list: `expression` ("," `expression`)* [","]
+ starred_list: `starred_item` ("," `starred_item`)* [","]
+ starred_expression: `expression` | (`starred_item` ",")* [`starred_item`]
 starred_item: `expression` | "*" `or_expr`
 
 .. index:: object: tuple
diff --git a/Doc/reference/simple_stmts.rst b/Doc/reference/simple_stmts.rst
index 8d17383853a3..76630dfc590f 100644
--- a/Doc/reference/simple_stmts.rst
+++ b/Doc/reference/simple_stmts.rst
@@ -708,15 +708,14 @@ The :keyword:`import` statement
 keyword: from
 
 .. productionlist::
- import_stmt: "import" `module` ["as" `name`] ( "," `module` ["as" `name`] )*
- : | "from" `relative_module` "import" `identifier` ["as" `name`]
- : ( "," `identifier` ["as" `name`] )*
- : | "from" `relative_module` "import" "(" `identifier` ["as" `name`]
- : ( "," `identifier` ["as" `name`] )* [","] ")"
+ import_stmt: "import" `module` ["as" `identifier`] ("," `module` ["as" `identifier`])*
+ : | "from" `relative_module` "import" `identifier` ["as" `identifier`]
+ : ("," `identifier` ["as" `identifier`])*
+ : | "from" `relative_module` "import" "(" `identifier` ["as" `identifier`]
+ : ("," `identifier` ["as" `identifier`])* [","] ")"
 : | "from" `module` "import" "*"
 module: (`identifier` ".")* `identifier`
 relative_module: "."* `module` | "."+
- name: `identifier`
 
 The basic import statement (no :keyword:`from` clause) is executed in two
 steps:
@@ -838,12 +837,11 @@ features on a per-module basis before the release in which the feature becomes
 standard.
 
 .. productionlist:: *
- future_statement: "from" "__future__" "import" feature ["as" name]
- : ("," feature ["as" name])*
- : | "from" "__future__" "import" "(" feature ["as" name]
- : ("," feature ["as" name])* [","] ")"
- feature: identifier
- name: identifier
+ future_stmt: "from" "__future__" "import" `feature` ["as" `identifier`]
+ : ("," `feature` ["as" `identifier`])*
+ : | "from" "__future__" "import" "(" `feature` ["as" `identifier`]
+ : ("," `feature` ["as" `identifier`])* [","] ")"
+ feature: `identifier`
 
 A future statement must appear near the top of the module. The only lines that
 can appear before a future statement are:
