Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

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

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
Copy link
Contributor

Also another issue in the file:

Image

The '/' are not escaped.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

2 participants