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 — [3.13] gh-127833: Docs: Add a `grammar-snippet` directive & replace `productionlist` (GH-127835) by miss-islington · Pull Request #129689 · python/cpython

Conversation

@miss-islington

@miss-islington miss-islington commented Feb 5, 2025 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

As a first step toward aligning the grammar documentation with Python's actual
grammar, this overrides the ReST productionlist directive to:

  • use : instead of the ::= symbol
  • add syntax highlighting for strings (using a Pygments highlighting class)

All links and link targets should be preserved. (Unfortunately, this reaches
into some Sphinx internals; I don't see a better way to do exactly what
Sphinx does.)

This also adds a new directive, grammar-snippet, which formats the snippet
almost exactly like what's in the source, modulo syntax highlighting and
keeping the backtick character to mark links to other rules.
This will allow formatting the snippets as in the grammar file
(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).

The new directive is applied to two simple rules in toplevel_components.rst


(cherry picked from commit 58a4357)

Co-authored-by: Petr Viktorin [email protected]
Co-authored-by: Blaise Pabon [email protected]
Co-authored-by: William Ferreira [email protected]
Co-authored-by: bswck [email protected]
Co-authored-by: Adam Turner [email protected]

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

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@encukou @blaisep
@wqferr @johnslavik @AA-Turner @miss-islington
pythongh-127833: Docs: Add a grammar-snippet directive & replace `p…
0f80ab2
…roductionlist` (pythonGH-127835)

As a first step toward aligning the grammar documentation with Python's actual
grammar, this overrides the ReST `productionlist` directive to:
- use `:` instead of the `::=` symbol
- add syntax highlighting for strings (using a Pygments highlighting class)

All links and link targets should be preserved. (Unfortunately, this reaches
into some Sphinx internals; I don't see a better way to do exactly what
Sphinx does.)

This also adds a new directive, `grammar-snippet`, which formats the snippet
almost exactly like what's in the source, modulo syntax highlighting and
keeping the backtick character to mark links to other rules.
This will allow formatting the snippets as in the grammar file
(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).

The new directive is applied to two simple rules in toplevel_components.rst

---------
(cherry picked from commit 58a4357)

Co-authored-by: Petr Viktorin <[email protected]>
Co-authored-by: Blaise Pabon <[email protected]>
Co-authored-by: William Ferreira <[email protected]>
Co-authored-by: bswck <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@bedevere-app bedevere-app Bot added the skip news label Feb 5, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Feb 5, 2025
gh-127833: Docs: Add a grammar-snippet directive & replace productionlist #127835
Merged
@bedevere-app bedevere-app Bot added the awaiting review label Feb 5, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Feb 5, 2025
Align the grammar documentation with Python's actual grammar #127833
Open
@encukou

encukou commented Feb 5, 2025

Copy link
Copy Markdown
Member

Let's not merge the backport just yet. I'd like to see this change go through the release process first.

All reactions

Sorry, something went wrong.

Uh oh!

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

@encukou
encukou marked this pull request as draft February 5, 2025 15:27
@bedevere-app bedevere-app Bot removed the awaiting review label Feb 5, 2025
@encukou

encukou commented Feb 17, 2025

Copy link
Copy Markdown
Member

It should be merged together with a follow-up PR, #129692. If at all.

All reactions

Sorry, something went wrong.

Uh oh!

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

@AA-Turner

AA-Turner commented Mar 20, 2025

Copy link
Copy Markdown
Member

#130376 fixes the help() output. I think we should backport, especially as this PR is a pre-requisite for all of the work done on improving how we describe the grammar in the documentation. What do you think @encukou?

A

All reactions

Sorry, something went wrong.

Uh oh!

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

@encukou

encukou commented Mar 21, 2025

Copy link
Copy Markdown
Member

I'm considering to backporting this for the syntax highlighting, but the upcoming grammar docs improvements are another matter. Those are tied to the current grammar, verifying them is a fiddly manual process, and they're interlinked in complex ways -- a token in some grammar rule might need to move to another rule in another file, which Git won't catch as a conflict, and the nonexistent tests won't either (of course I'd like to add tests, but that does require more automation, and in the current approach, rewriting the prose needs to come first.)

All reactions

Sorry, something went wrong.

Uh oh!

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

@encukou

encukou commented Aug 4, 2025

Copy link
Copy Markdown
Member

Let's keep it 3.14+.

All reactions

Sorry, something went wrong.

Uh oh!

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

@encukou encukou closed this Aug 4, 2025
@miss-islington
miss-islington deleted the backport-58a4357-3.13 branch January 2, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

Assignees

No one assigned

Labels

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.

3 participants

@miss-islington @encukou @AA-Turner
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.