add allow_unused config to missing_docs_in_private_items #14453
Merged
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
rustbot
added
the
S-waiting-on-review
samueltardieu
requested changes
Apr 6, 2025
clippy_lints/src/missing_doc.rs
Outdated
Comment on lines
267
to
272
| // Skip checking if the field starts with underscore and allow_unused is enabled | ||
| if self.allow_unused && sf.ident.as_str().starts_with('_') { | ||
| self.prev_span = Some(sf.span); | ||
| return; | ||
| } | ||
|
|
There was a problem hiding this comment.
You can group if conditions and keep only one exit point, this should be clearer since self.prev_span must be adjusted in all paths before leaving:
fn check_field_def(&mut self, cx: &LateContext<'tcx>, sf: &'tcx hir::FieldDef<'_>) {
if !sf.is_positional()
&& !(self.allow_unused && sf.ident.as_str().starts_with('_'))
&& !is_from_proc_macro(cx, sf)
{
let attrs = cx.tcx.hir_attrs(sf.hir_id);
self.check_missing_docs_attrs(cx, sf.def_id, attrs, sf.span, "a", "struct field");
}
self.prev_span = Some(sf.span);
}There was a problem hiding this comment.
Thank you for reviewing this PR and the guidance!
book/src/lint_configuration.md
Outdated
| @@ -723,6 +723,16 @@ Minimum chars an ident can have, anything below or equal to this will be linted. | |||
| * [`min_ident_chars`](https://rust-lang.github.io/rust-clippy/master/index.html#min_ident_chars) | |||
|
|
|||
|
|
|||
| ## `missing-docs-allow-unused` | |||
| Whether to allow fields starting with underscore to skip documentation requirements | |||
There was a problem hiding this comment.
nitpick: shouldn't it be "with underscores" or "with an underscore"? (repeated in other places)
| _field1: i32, // This should not trigger a warning | ||
| _field2: i32, // This should not trigger a warning | ||
| } | ||
|
|
There was a problem hiding this comment.
Could you also add the following test to ensure that a documented unused field does not trigger a warning, and that the documentation is not applied to the next field (which should be documented) either?
struct Test3 {
//~^ missing_docs_in_private_items
/// This field is documented although this is not mandatory
_unused: i32, // This should not trigger a warning because it starts with underscore
field3: i32, //~ missing_docs_in_private_items
}
|
Taking this one since I've reviewed it already. |
|
@rustbot author |
rustbot
added
S-waiting-on-author
|
Reminder, once the PR becomes ready for a review, use |
This comment has been minimized.
This comment has been minimized.
add allow_unused config to missing_docs_in_private_items for underscored field
quangcito
force-pushed
the
14413/missing_docs_in_private_items-config-suggestion-allow_unused
branch
from
95b6d00 to
64880ca
Compare
rustbot
removed
S-waiting-on-author
|
@rustbot ready |
rustbot
added
the
S-waiting-on-review
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.
fixes #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 fieldExplaination (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.