Skip to content

Add new check_private_items config #11842

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 21, 2023
Merged

Add new check_private_items config #11842

merged 2 commits into from
Nov 21, 2023

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Nov 19, 2023 •
edited by xFrednet
Loading

Fixes #11742.

It adds a new configuration which allows for MISSING_SAFETY_DOC, UNNECESSARY_SAFETY_DOC, MISSING_PANICS_DOC and MISSING_ERRORS_DOC lints to run on private items.

changelog: [missing_safety_doc], [unnecessary_safety_doc], [missing_panics_doc], [missing_errors_doc]: Added the [check-private-items] configuration to enable lints on private items.
#11842

r? @blyxyas

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Nov 19, 2023
@xFrednet
Copy link
Member

If this config is specific to doc lints it might be good to include that in the config name. If it's intended as a general setting, then the name should be fine :)

blyxyas
blyxyas requested changes Nov 19, 2023
View reviewed changes
Copy link
Member

@blyxyas blyxyas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Meow Meow
Currently blocked by #11801

@GuillaumeGomez
Copy link
Member Author

I kinda had in mind something that could be generalized indeed. Should I make the change to make it specific for docs?

blyxyas
blyxyas approved these changes Nov 19, 2023
View reviewed changes
Copy link
Member

@blyxyas blyxyas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, you're probably right, it should be a general configuration option. Thanks for the clarification.

LGTM, thanks! ❤️

@blyxyas blyxyas added the S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work label Nov 19, 2023
@GuillaumeGomez GuillaumeGomez force-pushed the check_private_items-config branch from b1b3924 to 1cbc945 Compare November 19, 2023 22:45
@GuillaumeGomez
Copy link
Member Author

Great! I blessed the failing test so now waiting for the other PR to get merged. :)

@bors
Copy link
Contributor

bors commented Nov 20, 2023

☔ The latest upstream changes (presumably #11801) made this pull request unmergeable. Please resolve the merge conflicts.

@blyxyas blyxyas removed the S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work label Nov 20, 2023
@GuillaumeGomez GuillaumeGomez force-pushed the check_private_items-config branch from 1cbc945 to f355943 Compare November 20, 2023 21:25
@GuillaumeGomez
Copy link
Member Author

Rebased and fixed the merge conflict.

blyxyas
blyxyas approved these changes Nov 21, 2023
View reviewed changes
Copy link
Member

@blyxyas blyxyas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Meow

@blyxyas
Copy link
Member

blyxyas commented Nov 21, 2023

@bors r+

@bors
Copy link
Contributor

bors commented Nov 21, 2023

📌 Commit f355943 has been approved by blyxyas

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Nov 21, 2023

⌛ Testing commit f355943 with merge 4b1d0aa...

@bors
Copy link
Contributor

bors commented Nov 21, 2023

💔 Test failed - checks-action_test

bors added a commit that referenced this pull request Nov 21, 2023
@bors
Auto merge of #11842 - GuillaumeGomez:check_private_items-config, r=b…
4b1d0aa 
…lyxyas

Add new `check_private_items` config

Fixes #11742.

It adds a new configuration which allows for `MISSING_SAFETY_DOC`, `UNNECESSARY_SAFETY_DOC`, `MISSING_PANICS_DOC` and `MISSING_ERRORS_DOC` lints to run on private items.

r? `@blyxyas`
@GuillaumeGomez
Copy link
Member Author

I forgot the changelog once again... Added it!

@xFrednet
Copy link
Member

@bors retry

@bors
Copy link
Contributor

bors commented Nov 21, 2023

⌛ Testing commit f355943 with merge 87162ca...

bors added a commit that referenced this pull request Nov 21, 2023
@bors
Auto merge of #11842 - GuillaumeGomez:check_private_items-config, r=b…
87162ca 
…lyxyas

Add new `check_private_items` config

Fixes #11742.

It adds a new configuration which allows for `MISSING_SAFETY_DOC`, `UNNECESSARY_SAFETY_DOC`, `MISSING_PANICS_DOC` and `MISSING_ERRORS_DOC` lints to run on private items.

changelog: add a new configuration which allows for `MISSING_SAFETY_DOC`, `UNNECESSARY_SAFETY_DOC`, `MISSING_PANICS_DOC` and `MISSING_ERRORS_DOC` lints to run on private items.

r? `@blyxyas`
@xFrednet
Copy link
Member

@bors r- (I've changed the changelog entry and want to refresh the commit)

@xFrednet
Copy link
Member

@GuillaumeGomez before I r=blyxyas, could you run cargo collect-metadata? The previous bors CI complained about this check, if I saw it correctly

@GuillaumeGomez
Copy link
Member Author

What message you want in the commit exactly? (So I can update it)

@xFrednet
Copy link
Member

xFrednet commented Nov 21, 2023 •
edited
Loading

I wanted to add links to the config and lint names. Usually we update the messages in the end, when the changelog is written, but some preprocessing never hurts ^^

@bors
Copy link
Contributor

bors commented Nov 21, 2023

💔 Test failed - checks-action_test

@GuillaumeGomez
[missing_safety_doc], [unnecessary_safety_doc], [`missing_panics_…
abd9deb 
…doc`], [`missing_errors_doc`]: Added the [`check-private-items`] configuration to enable lints on private items.

[rust-lang#11842](rust-lang#11842)
@GuillaumeGomez
Add ui test for check_private_items config
5cdda53
@GuillaumeGomez GuillaumeGomez force-pushed the check_private_items-config branch from f355943 to 5cdda53 Compare November 21, 2023 10:43
@GuillaumeGomez
Copy link
Member Author

Ran the command and updated the commit message.

@xFrednet
Copy link
Member

Thank you for the quick updates :D

@bors r=blyxyas

@bors
Copy link
Contributor

bors commented Nov 21, 2023

📌 Commit 5cdda53 has been approved by blyxyas

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Nov 21, 2023

⌛ Testing commit 5cdda53 with merge 4d56366...

@bors
Copy link
Contributor

bors commented Nov 21, 2023

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: blyxyas
Pushing 4d56366 to master...

@bors bors merged commit 4d56366 into rust-lang:master Nov 21, 2023
@GuillaumeGomez GuillaumeGomez deleted the check_private_items-config branch November 21, 2023 12:23
gernot-ohner pushed a commit to gernot-ohner/rust-clippy that referenced this pull request Dec 12, 2023
@GuillaumeGomez
[missing_safety_doc], [unnecessary_safety_doc], [`missing_panics_…
b7b9356 
…doc`], [`missing_errors_doc`]: Added the [`check-private-items`] configuration to enable lints on private items.

[rust-lang#11842](rust-lang#11842)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blyxyas blyxyas blyxyas approved these changes

Assignees

@blyxyas blyxyas

Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

missing_errors_doc and missing_panics_doc for private functions
5 participants
@GuillaumeGomez @xFrednet @bors @blyxyas @rustbot