-
-
Notifications
You must be signed in to change notification settings - Fork 31.8k
token module documentation is incomplete #130587
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
docs
Documentation in the Doc dir
Comments
This comment has been minimized.
This comment has been minimized.
encukou
added a commit
that referenced
this issue
Mar 19, 2025
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
to encukou/cpython
that referenced
this issue
Mar 19, 2025
…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
…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>
In this issue, the |
AA-Turner
pushed a commit
that referenced
this issue
Apr 9, 2025
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Apr 9, 2025
…ythonGH-132304) (cherry picked from commit a26d58c) Co-authored-by: Karolina Surma <33810531+befeleme@users.noreply.github.com>
AA-Turner
pushed a commit
that referenced
this issue
Apr 9, 2025
seehwan
pushed a commit
to seehwan/cpython
that referenced
this issue
Apr 16, 2025
…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>
seehwan
pushed a commit
to seehwan/cpython
that referenced
this issue
Apr 16, 2025
Oops! Thank you for the fix, @befeleme! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: