Docs: Miscellaneous corrections to simple statements in the language reference #126720
Conversation
Add :keyword: when it's needed
bedevere-app
bot
added
docs
Doc/reference/simple_stmts.rst
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
willingc
added
needs backport to 3.12
|
Thanks @bombs-kim for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
|
Sorry, @bombs-kim and @willingc, I could not cleanly backport this to |
|
Sorry, @bombs-kim and @willingc, I could not cleanly backport this to |
…reference (pythonGH-126720) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks (cherry picked from commit 94a7a4e)
|
GH-126885 is a backport of this pull request to the 3.13 branch. |
|
GH-126885 is a backport of this pull request to the 3.13 branch. |
1 similar comment
|
GH-126885 is a backport of this pull request to the 3.13 branch. |
…nguage reference (pythonGH-126720) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks (cherry picked from commit 94a7a4e) Co-authored-by: Beomsoo Kim <[email protected]>
|
GH-126891 is a backport of this pull request to the 3.12 branch. |
…nguage reference (GH-126720) (#126891) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks (cherry picked from commit 94a7a4e) Co-authored-by: Beomsoo Kim <[email protected]>
…s in the language reference (GH-126720) (#126885) Docs: Miscellaneous corrections to simple statements in the language reference (GH-126720) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks (cherry picked from commit 94a7a4e) Co-authored-by: Beomsoo Kim <[email protected]>
…reference (pythonGH-126720) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks
…reference (pythonGH-126720) * Replace: The :keyword:`global` -> The :keyword:`global` statement Add :keyword: when it's needed * Replace repeated links with duoble backticks
global-> The :keyword:globalstatement📚 Documentation preview 📚: https://cpython-previews--126720.org.readthedocs.build/