Document lint configuration values in Clippy's book

[tylerjw]

changelog: document lint configuration values in Clippy's book

fixes #9991

r? @xFrednet

[tylerjw]

To note, the reason for removing a reference to cognitive-complexity-threshold in the docs is that it encourages the use of a check in the Nursery because it is not well documented.

[tylerjw]

@xFrednet I believe I'm ready for a first review. Ok, now I am, fixed up the tests.

[xFrednet]

A solid start, thank you for the work! I've added some comments, and also gave some feedback about the table/format in the issue. I like the look of the table, but this might be a case where a different format is sadly more functional.

[tylerjw]

I updated this to produce both a table and paragraph sections. The table portion looks like this:

And then if you were to click on any of those configs it would go to a table section that looks like this:

I tried making the table widths work for the names, default values, and lints but couldn't get it to look good, so I moved the lints into the paragraphs and made the table just the config names and their default values. Clicking on any one goes to the paragraph, which now includes not only the list of lints but also the config type and the whole doc string.

[tylerjw]

@xFrednet this is ready for another review. I made some changes to how the generated doc output. Let me know if you have any ideas for how I could format it better and other things you notice that I could improve.

[xFrednet]

This version looks good to me! I have two more required adjustments, and then we can merge this.

1. Is the comment for the CI changes
2. Could you also update the add configuration to a lint section to have a 5th step, to run cargo collect-metadata?

Then this should be ready! Thank you very much for this update!!!!

[tylerjw]

@xFrednet I pushed the two changes you laid out. Thank you for going and figuring out the github actions magic I needed for this.

[xFrednet]

Everything looks perfect to me! Thank you very much. This is a very nice step forward for Clippy's configuration!

@bors r+

[bors]

📌 Commit c0da8ac has been approved by xFrednet

It is now in the queue for this repository.

[bors]

⌛ Testing commit c0da8ac with merge aceb443...

[bors]

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: xFrednet
Pushing aceb443 to master...

[flip1995]

Awesome! Thanks for implementing this :)

@xFrednet Sorry for not replying to your CI question. But the solution you came up with is perfect 👍

[xFrednet]

@flip1995 No problem at all, I would have waited if Google didn't turn up such a simple solution. :)