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

Traits mentioned in the docs not shown in the crate root #37

Closed
WhyNotHugo opened this issue Jun 8, 2023 · 1 comment · Fixed by #39
Closed

Traits mentioned in the docs not shown in the crate root #37

WhyNotHugo opened this issue Jun 8, 2023 · 1 comment · Fixed by #39

Comments

@WhyNotHugo
Copy link

The docs mention:

These traits are all defined – and explained en detail – in the [traits] module. They are, however, all re-exported here at the crate root.

Note that the [traits] link is not linkified, since there is no member with this name. Additionally, there are no traits listed in the root module:

image

If you want to re-export traits and have them show up in the documentation for the root module, you need to explicitly include pub use self::mod::trait. Using wildcards won't document them as expected.

@partim
Copy link
Member

partim commented Jul 18, 2023

Thank you for the report and sorry for the late reply. Looks like that doc string is a wee bit outdated.

As for the wildcard re-exports, they really shouldn’t be there: Only the main types and traits from every module should be re-exported. I’ll make a PR to fix that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants