gh-130587: Add hand-written docs for non-OP tokens #130588
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Blaise Pabon <[email protected]>
Co-authored-by: Blaise Pabon <[email protected]>
|
The rendered docs are at https://cpython-previews--130588.org.readthedocs.build/en/130588/library/token.html |
|
@lysnikolaou, does this look reasonable to you? |
AA-Turner
reviewed
Feb 26, 2025
lysnikolaou
reviewed
Feb 27, 2025
There was a problem hiding this comment.
This looks like a good improvement to me! Thanks @encukou!
I've left some inline comments regarding some specifics in the docs.
encukou
commented
Feb 27, 2025
encukou
commented
Feb 27, 2025
Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Lysandros Nikolaou <[email protected]>
|
Thank you for the reviews! I addressed some; I'll continue next week. |
encukou
commented
Mar 5, 2025
Comment on lines
+22
to
+25
| Note that a token's value may depend on tokenizer options. For example, a | ||
| ``"+"`` token may be reported as either :data:`PLUS` or :data:`OP`, or | ||
| a ``"match"`` token may be either :data:`NAME` or :data:`SOFT_KEYWORD`. | ||
|
|
There was a problem hiding this comment.
I added this note to clarify the “fuzziness” of these categories.
Co-authored-by: Adam Turner <[email protected]>
|
Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Sorry, @encukou, I could not cleanly backport this to |
|
GH-131465 is a backport of this pull request to the 3.13 branch. |
encukou
added a commit
to encukou/cpython
that referenced
this pull request
Mar 19, 2025
…0588) Co-authored-by: Blaise Pabon <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Lysandros Nikolaou <[email protected]> (cherry picked from commit 4bced29)
encukou
added a commit
to encukou/cpython
that referenced
this pull request
Mar 19, 2025
…onGH-130588) (cherry picked from commit 4bced29) Co-authored-by: Petr Viktorin <[email protected]> Co-authored-by: Blaise Pabon <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Lysandros Nikolaou <[email protected]>
encukou
added a commit
that referenced
this pull request
Mar 24, 2025
…GH-131465) Co-authored-by: Blaise Pabon <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Lysandros Nikolaou <[email protected]>
seehwan
pushed a commit
to seehwan/cpython
that referenced
this pull request
Apr 16, 2025
…0588) Co-authored-by: Blaise Pabon <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Lysandros Nikolaou <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add hand-written docs for non-OP tokens
Make the automation (
generate_token.py) check that the hand-written docs are present, and only generate docs for the OP tokensSwitch to
list-tablefor the OP tokens, to make their docs more compactAdd
ENDMARKERto the grammar docs where it appears (toplevel components)Add forgotten
versionchangedentry forEXCLAMATIONRemove docs for
NT_OFFSET📚 Documentation preview 📚: https://cpython-previews--130588.org.readthedocs.build/