Skip to content

Clippy Book Chapter Updates Reborn: Refresh Lint Configuration's looks - #10699

Merged
bors merged 1 commit into
rust-lang:masterfrom
blyxyas:book-lint_config
Jun 2, 2023
Merged

bors merged 1 commit into
rust-lang:masterfrom
blyxyas:book-lint_config

Conversation

@blyxyas

@blyxyas blyxyas commented Apr 22, 2023

Copy link
Copy Markdown
Member

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
Current

changelog: Refresh styling from the "Lint Configuration Options" book chapter.

@rustbot

rustbot commented Apr 22, 2023

Copy link
Copy Markdown
Collaborator

r? @Jarcho

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Apr 22, 2023
@bors

bors commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

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

@bors

bors commented May 9, 2023

Copy link
Copy Markdown
Contributor

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

@blyxyas
blyxyas force-pushed the book-lint_config branch from aeb4370 to 4649478 Compare May 9, 2023 19:29
@xFrednet

xFrednet commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

Hey @Jarcho, this is a ping from triage. Could you review this PR? If you're busy you can also pass it to me. I have a reviewing queue, but I should be able to get to this one within a week or so :)

@flip1995

flip1995 commented Jun 2, 2023

Copy link
Copy Markdown
Member

This PR also was on my todo list for some time. Just looked over it and this is an easy approval. Thanks for cleaning this up!

@bors r+

@bors

bors commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

📌 Commit b7a6054 has been approved by flip1995

It is now in the queue for this repository.

@bors

bors commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

⌛ Testing commit b7a6054 with merge 00001d6...

@bors

bors commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing 00001d6 to master...

@bors
bors merged commit 00001d6 into rust-lang:master Jun 2, 2023
@blyxyas
blyxyas deleted the book-lint_config branch October 5, 2023 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants