Skip to content

GH-97950: Use new-style index directive ('statement') #104162

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
May 4, 2023
Merged

GH-97950: Use new-style index directive ('statement') #104162

merged 4 commits into from
May 4, 2023

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented May 4, 2023 •
edited by github-actions bot
Loading

@bedevere-bot bedevere-bot mentioned this pull request May 4, 2023
Closed
@AA-Turner AA-Turner self-assigned this May 4, 2023
@AA-Turner AA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes labels May 4, 2023
ezio-melotti
ezio-melotti approved these changes May 4, 2023
View reviewed changes
Doc/reference/simple_stmts.rst
! statement: break
statement: for
statement: while
! pair: statement; break
Copy link
Member

Choose a reason for hiding this comment

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

What does the ! do?

Copy link
Member Author

Choose a reason for hiding this comment

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

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-index

You can mark up “main” index entries by prefixing them with an exclamation mark. The references to “main” entries are emphasized in the generated index. For example, if two pages contain

A little hard to discover, unfortunately.

@hugovk hugovk merged commit 55d50d1 into python:main May 4, 2023
@miss-islington
Copy link
Contributor

Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry @AA-Turner and @hugovk, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 55d50d147c953fab37b273bca9ab010f40e067d3 3.11

@miss-islington miss-islington assigned hugovk and unassigned AA-Turner May 4, 2023
@hugovk hugovk added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels May 4, 2023
@miss-islington
Copy link
Contributor

Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-104163 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 4, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 4, 2023
@AA-Turner @miss-islington
pythonGH-97950: Use new-style index directive ('statement') (pythonGH…
cb7222d 
…-104162)

(cherry picked from commit 55d50d1)

Co-authored-by: Adam Turner <[email protected]>
@hugovk
Copy link
Member

hugovk commented May 4, 2023

Momentary backport confusion from merging this before the previous backport was merged. All good for the second attempt 🚀

hugovk pushed a commit that referenced this pull request May 4, 2023
@miss-islington @AA-Turner
[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162…
6a970ae 
…) (#104163)

Co-authored-by: Adam Turner <[email protected]>
@mattwang44 mattwang44 mentioned this pull request Jul 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@ezio-melotti ezio-melotti ezio-melotti approved these changes

@CAM-Gerlach CAM-Gerlach Awaiting requested review from CAM-Gerlach

Assignees

@hugovk hugovk

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AA-Turner @miss-islington @bedevere-bot @hugovk @ezio-melotti