Skip to content

Commit 30c743f

Browse files
committed
Auto merge of rust-lang#11857 - matthri:add-collect-metadata-note, r=flip1995
Add documentation update hint using `cargo collect-metadata` This adds a little reminder to update the documentation in the book using `cargo collect-metadata` after changing the lint configuration since this can easily be missed (been there done that 🙈). > Yeah a note would be good, would be good for us to see if we can make it automatic also _Originally posted by `@Alexendoo` in rust-lang/rust-clippy#11757 (comment) Regarding the automation Im not sure whats the best option here. I thought about a kind of a "semi-automated" way, e.g. a `cargo dev` command which runs the "is the documentation updated" check (and maybe other useful checks) locally and reminds the user of updating the documentation so this gets caught before pushing. changelog: none
2 parents c24784e + c18e6ab commit 30c743f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

book/src/development/adding_lints.md

+2
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,8 @@ define_Conf! {
518518

519519
[`clippy_config::msrvs`]: https://doc.rust-lang.org/nightly/nightly-rustc/clippy_config/msrvs/index.html
520520

521+
Afterwards update the documentation for the book as described in [Adding configuration to a lint](#adding-configuration-to-a-lint).
522+
521523
## Author lint
522524

523525
If you have trouble implementing your lint, there is also the internal `author`

0 commit comments

Comments
 (0)