diff options
| author | bors <bors@rust-lang.org> | 2023-06-02 12:51:26 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-06-02 12:51:26 +0000 |
| commit | 00001d6e0835c07985cd1ffac8e3e231588fcfcc (patch) | |
| tree | c760c698732f9a178868769eebafefda4eceb332 /tests/mir-opt/lower_array_len.array_len_raw.NormalizeArrayLen.panic-unwind.diff | |
| parent | f0dc0bc1c2e7c2293bf601029c66f100a5228282 (diff) | |
| parent | b7a60547125fd1b0d06547ed038deb4a906afc67 (diff) | |
| download | rust-00001d6e0835c07985cd1ffac8e3e231588fcfcc.tar.gz rust-00001d6e0835c07985cd1ffac8e3e231588fcfcc.zip | |
Auto merge of #10699 - blyxyas:book-lint_config, r=flip1995
Clippy Book Chapter Updates Reborn: Refresh Lint Configuration's looks
This PR modernizes and clears up some confusion with the "Lint Configuration Options" chapter from the book.
### Changes
- **Remove 'Option - Default Value" table**
- Why was it even there?
- It shouldn't be the first thing an user sees when they enter the chapter. It's clunky, ugly and not useful. The default values for configs are stated in a per-config basis if needed.
- **Add a simple description of what the chapter contains, and the scheme of each configuration option**
- **Minor formatting, mainly adding code fragments to code text**
- It seemed weird and jarring not having back-ticks on text like "arithmetic_side_effects".
- Improves readability and separation between configs.
- **Separate a little bit the Affected Lints list + "Affected lists" message**
- Not having something indicating that the list is about the lints that use the configuration option is confusing.
- It isn't as important as the description and example. Therefore should be separated a little bit imo
---
This is an independent effort from #10597, but as it's still a Book Chapter Update, I thought it would be cool to include it here. I'm going to keep the reviewing process for this PR to rustbot's desires.
[Rendered](https://github.com/blyxyas/rust-clippy/blob/book-lint_config/book/src/lint_configuration.md)
[Current](https://github.com/rust-lang/rust-clippy/blob/master/book/src/lint_configuration.md)
changelog: Refresh styling from the "Lint Configuration Options" book chapter.
Diffstat (limited to 'tests/mir-opt/lower_array_len.array_len_raw.NormalizeArrayLen.panic-unwind.diff')
0 files changed, 0 insertions, 0 deletions