rust-clippy icon indicating copy to clipboard operation
rust-clippy copied to clipboard

Alphabetize configuration options and lints in Clippy documentation

Open CBSpeir opened this issue 1 year ago • 1 comments

changelog: none

r? blyxyas

CBSpeir avatar Feb 25 '24 03:02 CBSpeir

The file you changed is auto-generated by cargo collect-metadata. So in order to order them alphabetically (which makes sense) you'll have to change the generating code:

https://github.com/rust-lang/rust-clippy/blob/b09fb8ab3be9144725289ae89e60bb28301fe3c0/clippy_config/src/conf.rs#L195

flip1995 avatar Feb 26 '24 09:02 flip1995

Should I run cargo collect-metadata before pushing the commit?

I ran it for the latest commit pushed, which alphabetized lint_configuration.md as well as the auto-generated configuration options in CHANGELOG.md.

CBSpeir avatar Feb 28 '24 19:02 CBSpeir

Oh my suggestion also sorted the config options themselves alphabetically. I guess this is not a bad thing. I like it.

Yeah, you have to push those changes, otherwise CI will fail on merge:

https://github.com/rust-lang/rust-clippy/blob/139191b8b7b5ed181249e4a88bc3d7f7c01cce3c/.github/workflows/clippy_bors.yml#L159-L165

Thanks for this cleanup!

@bors r+

flip1995 avatar Feb 29 '24 09:02 flip1995

:pushpin: Commit d85642e6e80c448f8e3bf0797d381d434f472496 has been approved by flip1995

It is now in the queue for this repository.

bors avatar Feb 29 '24 09:02 bors

:hourglass: Testing commit d85642e6e80c448f8e3bf0797d381d434f472496 with merge 04b74ee392bec1031a386e0ac8b7e22d76487da1...

bors avatar Feb 29 '24 11:02 bors

:sunny: Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test Approved by: flip1995 Pushing 04b74ee392bec1031a386e0ac8b7e22d76487da1 to master...

bors avatar Feb 29 '24 11:02 bors