NotificationsYou must be signed in to change notification settings
Fork32.1k
Star67.3k

gh-127833: Fix grammar snippet formatting for help() output#129692

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

encukou wants to merge6 commits intopython:mainfromencukou:doc-grammar-snippets

Closed

gh-127833: Fix grammar snippet formatting for help() output#129692

encukou wants to merge6 commits intopython:mainfromencukou:doc-grammar-snippets

Conversation

Copy link

Member

encukou commentedFeb 5, 2025•
edited by github-actionsbot
Loading

Change pydoc_data to show the "input" of grammar snippet
directives, which is formatted the way we want.

See also this Sphinx issue:sphinx-doc/sphinx#13302
And:sphinx-doc/sphinx#4454

A known issue is cross-grammar links, like those in
the string format specification mini-language, which render
as reST source:

element_index:     `~python-grammar:digit`+ | `index_string`

I don't see a good way to fix this before Sphinx is refactored.

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

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

encukou added2 commits

February 5, 2025 17:56

Fix grammar snippet formatting for help() output

af3ce4f

Change pydoc_data to show the "input" of grammar snippetdirectives, which is formatted the way we want.See also this Sphinx issue:sphinx-doc/sphinx#13302And:sphinx-doc/sphinx#4454A known issue is cross-grammar links, like those inthe string format specification mini-language, which renderas reST source:    element_index:     `~python-grammar:digit`+ | `index_string`I don't see a good way to fix this before Sphinx is refactored.

Commit the generated pydoc_data changes

1af8b90