Fix missing_doc lint #14413
Closed
Fix missing_doc lint #14413
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some items including traits are exported even when they aren't public, so the missing_doc lint used to warn for private traits. Closes rust-lang#11592
|
For traits, this was intentionally done for cases such as: trait Foo {}
pub fn foo<T: Foo>() {}Does this modification allow |
|
It does. It seems to me that rustdoc and the VisiblePrivateType lint should be updated to use |
|
(Travis failed.) |
flip1995
pushed a commit
to flip1995/rust
that referenced
this pull request
May 15, 2025
…4453) fixes rust-lang#14413 add allow_unused config to missing_docs_in_private_items for underscored field changelog: [`missing_docs_in_private_items`]: add allow_unused config to missing_docs_in_private_items for underscored field Explaination (quoted from the issue's author): When writing structures that must adhere to a specific format (such as memory mapped I/O structures) there are inevitably fields that are "reserved" by specifications and thus need no documentation. In cases where private docs are preferred but reserved fields need no explanation, having to #[allow/expect] this lint removes the ability to check for otherwise used fields' documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some items including traits are exported even when they aren't public,
so the missing_doc lint used to warn for private traits.
Closes #11592