GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GH-97950: Use new-style index directive ('statement') by AA-Turner · Pull Request #104162 · python/cpython

Conversation

@AA-Turner

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member
  • Issue: Docs use deprecated Sphinx .. index:: entries #97950

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
AA-Turner added 4 commits May 4, 2023 11:36
@AA-Turner
Uncomment statement removal in pairindextypes
8a250ee
@AA-Turner
Use new-style index directive ('statement') - Library
0d7320d
@AA-Turner
Use new-style index directive ('statement') - Reference
46464b7
@AA-Turner
Use new-style index directive ('statement') - Tutorial
14c7d92
@bedevere-bot bedevere-bot mentioned this pull request May 4, 2023
Docs use deprecated Sphinx .. index:: entries #97950
Closed
@bedevere-bot bedevere-bot added the awaiting review label May 4, 2023
@AA-Turner
AA-Turner requested review from CAM-Gerlach, ezio-melotti and hugovk May 4, 2023 10:37
@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
Comment thread Doc/reference/simple_stmts.rst
! statement: break
statement: for
statement: while
! pair: statement; break

@ezio-melotti ezio-melotti May 4, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

What does the ! do?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@AA-Turner AA-Turner May 4, 2023

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels May 4, 2023
hugovk
hugovk approved these changes May 4, 2023
View reviewed changes
@hugovk
hugovk merged commit 55d50d1 into python:main May 4, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label May 4, 2023
@miss-islington

miss-islington commented May 4, 2023

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington

miss-islington commented May 4, 2023

Copy link
Copy Markdown
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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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

miss-islington commented May 4, 2023

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot

bedevere-bot commented May 4, 2023

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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

hugovk commented May 4, 2023

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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
[3.11] GH-97950: Fix old-style index directive in Doc/library/imp.rst #107246
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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@AA-Turner @miss-islington @bedevere-bot @hugovk @ezio-melotti
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.