Skip to content

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

Closed
encukou opened this issue Feb 26, 2025 · 3 comments
Closed

token module documentation is incomplete #130587

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

Comments

@encukou
Copy link
Member

encukou commented Feb 26, 2025

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

@StanFromIreland

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
…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
…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>
@befeleme
Copy link
Contributor

befeleme commented Apr 9, 2025

In this issue, the make_rst function was extended to accept another argument, rstfile. Makefile.pre.in was not updated accordingly, causing the regen directive to fail in our Fedora environment where we can't deal with relative paths (as the default value of rstfile is defined).

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
…H-132304) (#132327)

Co-authored-by: Karolina Surma <33810531+befeleme@users.noreply.github.com>
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>
@encukou
Copy link
Member Author

encukou commented May 5, 2025

Oops! Thank you for the fix, @befeleme!

@encukou encukou closed this as completed May 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

3 participants