-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme improvements #6287
Readme improvements #6287
Conversation
r? @llogiq (rust_highfive has picked a reviewer for you, use r? to override) |
I don't see how this makes the "All the Clippy lints" link clearer. Having the ToC where it currently is, is actually intentional, since we want to have the most relevant information for the user at the top. If you want more information, you scroll past this either way. Having a ToC on top doesn't help find this information faster. -1 for this change from me. I like the reformat to a table though (but without the traffic lights). |
As @flip1995 wrote, we would want some changes before merging this. I will look into this later, just know that we'll need some discussion. |
Here is take 2 with flip1995's input: camsteffen@25be6e7 |
The changes in camsteffen@25be6e7 LGTM. @llogiq r=me if those changes are pushed and you're also good with them. 👍 |
The problem becomes that |
Format lint categories as a table with the default lint level.
Pushed the revised version. I think that resolves the concern with |
Thank you! @bors r+ |
📌 Commit fd8dece has been approved by |
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
Moved the table of contents up, added an Overview heading.Made the "All the Clippy Lints" link clearer.Formatted the lint categories as a table with the default lint level (instead of saying on/off by default). Tweaked the descriptions.
changelog: Improve Readme