Skip to content
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

[docgen] Add prefix to module names for generated documentation #16973

Closed
konsumlamm opened this issue Feb 8, 2021 · 0 comments · Fixed by #16999
Closed

[docgen] Add prefix to module names for generated documentation #16973

konsumlamm opened this issue Feb 8, 2021 · 0 comments · Fixed by #16999
Labels
Documentation Generation Related to documentation generation (but not content).

Comments

@konsumlamm
Copy link
Contributor

Summary

It would be nice if modules had the full path prefix in the heading of their generated documentation. For example, for the standard library, this would mean that all modules (or only the ones in the std directory) would get a std/ prefix:

std/packedsets

This should also work for nested paths, for example:

std/private/since

Advantages

  • It wouldn't be necessary anymore to add a note that a module needs to be imported with a std/ prefix
  • It is encouraged to use the full path prefix (at least for the standard library) anyway, so this would help to push that
@ghost ghost added the Documentation Generation Related to documentation generation (but not content). label Mar 12, 2021
Araq pushed a commit that referenced this issue Mar 23, 2021
#16999)

* nim doc now shows correct import name in title
ardek66 pushed a commit to ardek66/Nim that referenced this issue Mar 26, 2021
… in title (nim-lang#16999)

* nim doc now shows correct import name in title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant