-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
No link to std/exitprocs in docs (+enumerate,jsonutils etc) #16046
Comments
see #15694 (comment) note that search works: if you click on the link there's at least now a Source link that shows it's under
like all new modules in stdlib. instead, this is how we can improve things: automatically show proper fully qualified import syntax in docsin docs, instead of showing the module name (exitprocs for https://nim-lang.github.io/Nim/exitprocs.html) or depending on for exitprocs: this should be auto-generated (not mentioned for each module in some doc comment), otherwise it's a total waste of time. make sure each stdlib module is referenced in doc/lib.rst (https://nim-lang.github.io/Nim/lib.html)kochdocs could add some logic to check that all docgen'd stdlib modules are mentioned in lib.rst, that way, it'd always stay in sync. I'm sure other modules are missing. |
Autogenerating the import syntax in the docs would be great |
Also https://nim-lang.org/docs/jsonutils.html is unlinked. |
Note that https://nim-lang.github.io/Nim/theindex.html already references all modules (including exitprocs etc), and in general automated solutions are preferable. |
Duplicate of #16656 |
See #15694 for discussion. I tried importing
exitprocs
only to get an error saying it couldn't open it. Turns out it's instd
and the docs page makes no mention of how to import it. In addition, it's not listed in the stdlib directory.The text was updated successfully, but these errors were encountered: