gh-134026: Fix grammar description of for statement #134034
Conversation
|
All commit authors signed the Contributor License Agreement. |
Doc/reference/compound_stmts.rst
Outdated
| @@ -151,21 +151,22 @@ The :keyword:`!for` statement | |||
| single: : (colon); compound statement | |||
|
|
|||
| The :keyword:`for` statement is used to iterate over the elements of a sequence | |||
| (such as a string, tuple or list) or other iterable object: | |||
| (such as a string, tuple, or list) or other iterable object: | |||
There was a problem hiding this comment.
Please see warnings on your pr.
There was a problem hiding this comment.
okay yea saw it. found a "starred_expression_list" in the https://docs.python.org/3/reference/expressions.html#grammar-token-python-grammar-starred_expression_list. I will try to link it to that instead then
There was a problem hiding this comment.
@skirpichev done, i reviewed it locally and doc seems proper. starred_list is turned into starred_expression_list mentioned already in https://docs.python.org/3/reference/expressions.html#grammar-token-python-grammar-starred_expression_list
There was a problem hiding this comment.
Why this comma? Seems unrelated to the pr content.
There was a problem hiding this comment.
Why this comma? Seems unrelated to the pr content.
While changing i just noticed a small grammar error and thought of fixing it. Its a small mistake but comma should be there after the tuple, I can make a separate PR for it if you want
There was a problem hiding this comment.
@StanFromIreland, does this looks correct for you?
There was a problem hiding this comment.
It is an oxford comma, its usage is varied across contexts, but generally recommended in formal writing.
It is unrelated to this pr and not very important, I am not against it staying, but I wouldn't be heavily opposed to removing it either.
9967ec9 to
e760500
Compare
|
@skirpichev do i need to fix something? i dont know what being marked as draft is suppose to imply |
…stmt-docs # Conflicts: # Doc/reference/compound_stmts.rst
Doc/reference/compound_stmts.rst
Outdated
| The first item provided | ||
| by the iterator is then assigned to the target list using the standard | ||
| The :token:`~python-grammar:starred_expression_list` expression is evaluated once; | ||
| it should yield an :term:`iterable` object. An :term:`iterator` is created for that iterable. |
There was a problem hiding this comment.
If you change this line in any case, please break it between sentences. Otherwise the line is too long. Even if the linter is silent, the recommended size is less than 80 columns.
|
Thanks @Yash-Vijay29 for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
|
Thank you for the fix! |
|
GH-134424 is a backport of this pull request to the 3.14 branch. |
What’s changed
Doc/reference/compound_stmts.rst, replaced the undefinedstarred_listtoken with the actual grammar productionstarred_expression_listin thefor_stmtrule.Why
starred_listis not linked to anything, i believe it was a typo for 'starred_expression_list" that exists in https://docs.python.org/3/reference/expressions.html#grammar-token-python-grammar-starred_expression_listBackwards compatibility
Further notes
starred_expression_list.📚 Documentation preview 📚: https://cpython-previews--134034.org.readthedocs.build/