Skip to content

Docs: Miscellaneous corrections to simple statements in the language reference #126720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Doc/reference/simple_stmts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ These equivalences assume that :const:`__debug__` and :exc:`AssertionError` refe
the built-in variables with those names. In the current implementation, the
built-in variable :const:`__debug__` is ``True`` under normal circumstances,
``False`` when optimization is requested (command line option :option:`-O`). The current
code generator emits no code for an assert statement when optimization is
code generator emits no code for an :keyword:`assert` statement when optimization is
requested at compile time. Note that it is unnecessary to include the source
code for the expression that failed in the error message; it will be displayed
as part of the stack trace.
Expand Down Expand Up @@ -533,8 +533,8 @@ The :keyword:`!yield` statement
yield_stmt: `yield_expression`

A :keyword:`yield` statement is semantically equivalent to a :ref:`yield
expression <yieldexpr>`. The yield statement can be used to omit the parentheses
that would otherwise be required in the equivalent yield expression
expression <yieldexpr>`. The :keyword:`yield` statement can be used to omit the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might have been intentional here to not use markup: we don’t want a paragraph littered with the same link. So double backticks could be enough.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a link to the Devguide @bombs-kim https://devguide.python.org/documentation/style-guide/#links

As @merwok mentions there is no need to have multiple links in the same paragraph, double backticks would be preferred.

parentheses that would otherwise be required in the equivalent yield expression
statement. For example, the yield statements ::

yield <expr>
Expand All @@ -546,7 +546,7 @@ are equivalent to the yield expression statements ::
(yield from <expr>)

Yield expressions and statements are only used when defining a :term:`generator`
function, and are only used in the body of the generator function. Using yield
function, and are only used in the body of the generator function. Using :keyword:`yield`
in a function definition is sufficient to cause that definition to create a
generator function instead of a normal function.

Expand Down Expand Up @@ -966,12 +966,12 @@ The :keyword:`!global` statement
.. productionlist:: python-grammar
global_stmt: "global" `identifier` ("," `identifier`)*

The :keyword:`global` causes the listed identifiers to be interpreted
The :keyword:`global` statement causes the listed identifiers to be interpreted
as globals. It would be impossible to assign to a global variable without
:keyword:`!global`, although free variables may refer to globals without being
declared global.

The global statement applies to the entire scope of a function or
The :keyword:`global` statement applies to the entire scope of a function or
class body. A :exc:`SyntaxError` is raised if a variable is used or
assigned to prior to its global declaration in the scope.

Expand Down Expand Up @@ -1009,7 +1009,7 @@ identifiers. If a name is bound in more than one nonlocal scope, the
nearest binding is used. If a name is not bound in any nonlocal scope,
or if there is no nonlocal scope, a :exc:`SyntaxError` is raised.

The nonlocal statement applies to the entire scope of a function or
The :keyword:`nonlocal` statement applies to the entire scope of a function or
class body. A :exc:`SyntaxError` is raised if a variable is used or
assigned to prior to its nonlocal declaration in the scope.

Expand Down
Loading