-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Beta rustc warns on missing documentation for an extern crate even though the docstring is not used by rustdoc #112308
Comments
Thanks for opening the issue! We have a few items where the documentation is ignored. I think for the current case, the best would be to not warn as a first step. Then we should maybe discuss whether or not we want to display documentation for these items and also how. It was suggested some time ago to create pages to list such items (by grouping them). To be discussed. |
@GuillaumeGomez, the warning is still present in current beta , |
It should be backported to beta. |
I just noticed that 1.71.0 is already in pre-release testing, https://internals.rust-lang.org/t/rust-1-71-0-pre-release-testing/19123 |
I don't know, we'll see. If not we can always do a stable backport. |
Due to rust-lang/rust#112308, the public re-export of the pac will trigger a missing docs warning in rust 1.71.0. This is bogus, as the doc string would not be shown in the rendered docs anyway. However, the warning would be annoying, so add a short doc string to the item.
minimal example:
Running
cargo check
on this example outputs no warning on stable 1.70.0, but on eitherrustc 1.71.0-beta.2 (4e8c9e8e3 2023-06-04)
orrustc 1.72.0-nightly (101fa903b 2023-06-04)
it outputs the following warning:Adding a docstring does silence the warning, but as far as I can tell this docstring is not used anywhere by rustdoc: adding it has no impact on the generated documentation.
I suppose either the warning is inadequate, or rustdoc should display that docstring.
cc @GuillaumeGomez
The text was updated successfully, but these errors were encountered: