Skip to content
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

token module documentation is incomplete #130587

Open
encukou opened this issue Feb 26, 2025 · 1 comment
Open

token module documentation is incomplete #130587

encukou opened this issue Feb 26, 2025 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@encukou
Copy link
Member

encukou commented Feb 26, 2025 •
edited by bedevere-app bot
Loading

Documentation

The token docs use a generated list of tokens, with short blurbs for the OP tokens but nothing for the other (more interesting) ones.
Some tokens (COMMENT, NL, etc.) have secondary, hand-written definitions. However, these are excluded from the index; links go to the empty entries.

I propose adding hand-written prose for the non-OP tokens, and changing the automation to check the entries rather than generate them.
For the OP tokens, generating the docs is the correct thing to do, but the list can be more compact since they're all the same.

Linked PRs
@encukou encukou added the docs Documentation in the Doc dir label Feb 26, 2025
@bedevere-app bedevere-app bot mentioned this issue Feb 26, 2025
Merged
@StanFromIreland

This comment has been minimized.

Sign in to view
encukou added a commit that referenced this issue Mar 19, 2025
@encukou @blaisep
@AA-Turner @lysnikolaou
gh-130587: Add hand-written docs for non-OP tokens (GH-130588)
4bced29 
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue Mar 19, 2025
Merged
encukou added a commit to encukou/cpython that referenced this issue Mar 19, 2025
@encukou
pythongh-130587: Add hand-written docs for non-OP tokens (pythonGH-13…
d713970 
…0588)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
(cherry picked from commit 4bced29)
encukou added a commit to encukou/cpython that referenced this issue Mar 19, 2025
@encukou @blaisep
@AA-Turner @lysnikolaou
[3.13] pythongh-130587: Add hand-written docs for non-OP tokens (pyth…
26df396 
…onGH-130588)

(cherry picked from commit 4bced29)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
encukou added a commit that referenced this issue Mar 24, 2025
@encukou @blaisep
@AA-Turner @lysnikolaou
[3.13] gh-130587: Add hand-written docs for non-OP tokens (GH-130588) (…
478eb73 
…GH-131465)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
2 participants
@encukou @StanFromIreland