gh-134026: Fix grammar description of for statement by Yash-Vijay29 · Pull Request #134034 · python/cpython · GitHub

What’s changed

In Doc/reference/compound_stmts.rst, replaced the undefined starred_list token with the actual grammar production starred_expression_list in the for_stmt rule.

Why

starred_list is 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_list

Backwards compatibility

This is purely a docs change; there’s no impact on existing code or behavior.

Further notes

As of Python 3.11, starred unpacking in the iterable is supported and described by starred_expression_list.
Closes issue Replace "starred_list" with standard grammar term "expression_list" in for statement documentation #134026 (docs grammar inconsistency).

Issue: Replace "starred_list" with standard grammar term "expression_list" in for statement documentation #134026

📚 Documentation preview 📚: https://cpython-previews--134034.org.readthedocs.build/

…on_list

All commit authors signed the Contributor License Agreement.

Please see warnings on your pr.

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

@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

Why this comma? Seems unrelated to the pr content.

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

@StanFromIreland, does this looks correct for you?

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.

…on_list

@skirpichev do i need to fix something? i dont know what being marked as draft is suppose to imply

You can mark it as ready for review whenever you feel it is. Currently it is not.

See my comments, and I recommended you read the devguide. (Sections on documentation and pr lifecycle will be particularly handy now)

…stmt-docs # Conflicts: # Doc/reference/compound_stmts.rst

Minor change needed otherwise good to go

LGTM, but please fix long lines.

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.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

Thank you for the fix!

…34034) (cherry picked from commit 4eacf38) Co-authored-by: Yash Vijay <yash_vijay@outlook.com>

GH-134424 is a backport of this pull request to the 3.14 branch.

GH-134424) gh-134026: Fix grammar description of for statement (GH-134034) (cherry picked from commit 4eacf38) Co-authored-by: Yash Vijay <yash_vijay@outlook.com>

…34034)

Yash-Vijay29 added 2 commits May 15, 2025 12:15

doc: clarify for_stmt grammar by replacing starred_list with expressi…

6873af5

…on_list

star_expressions

3795065

Yash-Vijay29 requested review from AA-Turner and willingc as code owners May 15, 2025 07:41

bedevere-app Bot added docs Documentation in the Doc dir skip news labels May 15, 2025

bedevere-app Bot mentioned this pull request May 15, 2025

Replace "starred_list" with standard grammar term "expression_list" in for statement documentation #134026

Closed

bedevere-app Bot added the awaiting review label May 15, 2025

github-project-automation Bot added this to Docs PRs May 15, 2025

github-project-automation Bot moved this to Todo in Docs PRs May 15, 2025

Merge branch 'main' into fix-for-stmt-docs

02c6d47

skirpichev reviewed May 15, 2025

View reviewed changes

Yash-Vijay29 added 2 commits May 15, 2025 14:26

star_expressions

1152b1b

star_expressions

9967ec9

skirpichev marked this pull request as draft May 15, 2025 09:39

bedevere-app Bot removed the awaiting review label May 15, 2025

Yash-Vijay29 added 4 commits May 15, 2025 15:39

doc: clarify for_stmt grammar by replacing starred_list with expressi…

9442bf8

…on_list

star_expressions

c9abb45

star_expressions

ec6005b

star_expressions

e760500

skirpichev self-requested a review May 15, 2025 10:23

StanFromIreland reviewed May 15, 2025

View reviewed changes

Comment thread Doc/reference/compound_stmts.rst Outdated

Comment thread Doc/reference/compound_stmts.rst Outdated

Yash-Vijay29 added 4 commits May 16, 2025 09:51

star_expressions

b8beb7d

Merge remote-tracking branch 'origin/fix-for-stmt-docs' into fix-for-…

7f53e8b

…stmt-docs # Conflicts: # Doc/reference/compound_stmts.rst

Update compound_stmts.rst

e908fce

Update compound_stmts.rst

50f1e09

Yash-Vijay29 marked this pull request as ready for review May 16, 2025 04:43

bedevere-app Bot added the awaiting review label May 16, 2025

bedevere-app Bot added the awaiting review label May 18, 2025

skirpichev requested a review from StanFromIreland May 18, 2025 08:14

StanFromIreland approved these changes May 18, 2025

View reviewed changes

Comment thread Doc/reference/compound_stmts.rst Outdated

bedevere-app Bot added awaiting core review and removed awaiting review labels May 18, 2025

Yash-Vijay29 added 2 commits May 18, 2025 14:31

Update compound_stmts.rst

9af4d49

Merge branch 'main' into fix-for-stmt-docs

0ef3fb7

serhiy-storchaka reviewed May 21, 2025

View reviewed changes

Update compound_stmts.rst

5ce932e

Yash-Vijay29 commented May 21, 2025

View reviewed changes

Comment thread Doc/reference/compound_stmts.rst Outdated

Update compound_stmts.rst

0417261

encukou approved these changes May 21, 2025

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting core review labels May 21, 2025

encukou added the needs backport to 3.14 bugs and security fixes label May 21, 2025

encukou mentioned this pull request May 21, 2025

Align the grammar documentation with Python's actual grammar #127833

Open

encukou merged commit 4eacf38 into python:main May 21, 2025

github-project-automation Bot moved this from Todo to Done in Docs PRs May 21, 2025

bedevere-app Bot removed the awaiting merge label May 21, 2025

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2025

pythongh-134026 : Fix grammar description of for statement (pythonGH-1…

b400236

…34034) (cherry picked from commit 4eacf38) Co-authored-by: Yash Vijay <yash_vijay@outlook.com>

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label May 21, 2025

Yash-Vijay29 deleted the fix-for-stmt-docs branch May 21, 2025 15:55

lkollar pushed a commit to lkollar/cpython that referenced this pull request May 26, 2025

pythongh-134026 : Fix grammar description of for statement (pythonGH-1…

46f5fec

…34034)

Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025

pythongh-134026 : Fix grammar description of for statement (pythonGH-1…

2e5fd0c

…34034)

taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025

pythongh-134026 : Fix grammar description of for statement (pythonGH-1…

40f5d84

…34034)

gostak-dd pushed a commit to gostak-dd/cpython that referenced this pull request Jun 2, 2026

pythongh-134026 : Fix grammar description of for statement (pythonGH-1…

8bb75db

…34034)

-              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.

               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:

gh-134026: Fix grammar description of for statement by Yash-Vijay29 · Pull Request #134034 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-134026: Fix grammar description of for statement - #134034

gh-134026: Fix grammar description of for statement#134034encukou merged 26 commits intopython:mainpython/cpython:mainfrom Yash-Vijay29:fix-for-stmt-docsCopy head branch name to clipboard

Conversation

Yash-Vijay29 commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What’s changed

Why

Backwards compatibility

Further notes

Uh oh!

python-cla-bot Bot commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yash-Vijay29 commented May 15, 2025

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

miss-islington-app Bot commented May 21, 2025

Uh oh!

encukou commented May 21, 2025

Uh oh!

bedevere-app Bot commented May 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gh-134026: Fix grammar description of for statement#134034
encukou merged 26 commits into
python:mainfrom
Yash-Vijay29:fix-for-stmt-docs

Yash-Vijay29 commented May 15, 2025 •
edited
Loading

python-cla-bot Bot commented May 15, 2025 •
edited
Loading