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

add allow_unused config to missing_docs_in_private_items #14453

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

quangcito
Copy link

@quangcito quangcito commented Mar 23, 2025

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 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.

add allow_unused config to missing_docs_in_private_items for underscored field
@rustbot
Copy link
Collaborator

rustbot commented Mar 23, 2025

r? @Jarcho

rustbot has assigned @Jarcho.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Mar 23, 2025
@quangcito quangcito marked this pull request as ready for review March 23, 2025 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing_docs_in_private_items config suggestion allow_unused
3 participants