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

[rustdoc] Some items don't have documentation rendered #112379

Open
GuillaumeGomez opened this issue Jun 7, 2023 · 0 comments
Open

[rustdoc] Some items don't have documentation rendered #112379

GuillaumeGomez opened this issue Jun 7, 2023 · 0 comments
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. I-needs-decision Issue: In need of a decision. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Jun 7, 2023

This comes from #112308: some items like non-inlined re-exports or pub extern crate don't have any documentation rendered although they appear in documentation. The reason is that they don't have their own page. Something that was suggested was to group items that "couldn't be implementated using impl block" into their own page (like constants, statics, non-inlined re-exports, etc). So all constants would into a same constants.html page. But that would be for later since it'd change URLs, requiring an RFC.

The motivation behind this is to allow all items into the documentation to have the same behaviour: on the module page, short documentation. On their "own" (grouped) page, full documentation.

What do you think @rust-lang/rustdoc?

@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Jun 7, 2023
@jyn514 jyn514 added C-bug Category: This is a bug. I-needs-decision Issue: In need of a decision. labels Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. I-needs-decision Issue: In need of a decision. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

2 participants