Skip to content

gh-158836: Clarify compound statement structure - #158854

Closed
rupayon123 wants to merge 3 commits into
python:mainfrom
rupayon123:docs/compound-statement-clauses-158836
Closed

rupayon123 wants to merge 3 commits into
python:mainfrom
rupayon123:docs/compound-statement-clauses-158836

Conversation

@rupayon123

@rupayon123 rupayon123 commented Oct 5, 2026 •

Copy link
Copy Markdown

Summary

Clarify that clauses within a statement align, while match statements contain nested case blocks in their suite. Also remove the claim that every header starts with a uniquely identifying keyword, and explain the two-keyword async forms.

This addresses #158836.

Testing

  • sphinx-lint --enable=default-role Doc/reference/compound_stmts.rst passed.
  • git diff --check passed.
  • A full Sphinx documentation build was not run; Sphinx is not installed in this environment.

AI assistance was used to investigate the issue and draft the documentation wording. I reviewed the revised description against the current grammar and surrounding reference text.

@python-cla-bot

python-cla-bot Bot commented Oct 5, 2026

Copy link
Copy Markdown

The following commit authors need to sign the Contributor License Agreement:

CLA not signed

@bedevere-app

bedevere-app Bot commented Oct 5, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@@ -0,0 +1,2 @@
Clarify how clauses relate to compound-statement headers and explain that

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You don't need a NEWS entry.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Removed both NEWS fragments from the PR in 9529edc. The diff now contains only the documentation wording change. The bot says low-impact changes need a maintainer-applied skip news label; please add it if that is the required path here.

@rupayon123

Copy link
Copy Markdown
Author

I added the requested Documentation NEWS entry at Misc/NEWS.d/next/Documentation/2026-10-06-09-35-49.gh-issue-158836.d4db26.rst. It parses as reStructuredText, and the new commit is ece09b8f21b2511ad5f8635a8b65d587876e7ec5. The CLA status still shows pending, so the account holder needs to complete that step before the PR can proceed.

@bedevere-app

bedevere-app Bot commented Oct 6, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34969865 | 📁 Comparing 9529edc against main (82c62ab)

  🔍 Preview build  

1 file changed
± reference/compound_stmts.html

@picnixz

picnixz commented Oct 6, 2026

Copy link
Copy Markdown
Member

The CLA status still shows pending, so the account holder needs to complete that step before the PR can proceed.

Automated agents are not allowed. Should this repeat, we will ban you from contributing to our repositories.

@picnixz picnixz closed this Oct 6, 2026
@picnixz

picnixz commented Oct 6, 2026

Copy link
Copy Markdown
Member

@python/organization-owners Please ban this user. This is not the first PR they opened using a bot. TiA!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants