-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Open
Labels
A-documentationArea: Adding or improving documentationArea: Adding or improving documentationC-tracking-issueCategory: Tracking IssueCategory: Tracking Issue
Description
Tracking issue for all relating to the Clippy Book Chapter Updates Reborn project.
If you have anything relating to the whole project, please comment it here instead of in an individual PR.
NAME | STATUS | REF |
---|---|---|
Defining lints | Merged ✨ | #10595 |
Writing tests | Merged ✨ | #10596 |
Lint passes | Merged ✨ | #10622 |
Emitting lints | Merged ✨ | #10598 |
Type Checking | Merged ✨ | #10605 |
Trait Checking | PR Open 🔮 | #10626 |
Method Checking | Merged ✨ | #10644 |
Macro Expansions | Merged ✨ | #10652 |
HirIds | Needs discussion 🐝 | |
Example: Late Lint | Working on 🦕 | |
Example: Early Lint | PR Open 🔮 | #11352 |
Adding documentation | Not started yet 🍅 | |
The review process | Not started yet 🍅 |
You can comment about which chapters to add or remove.
Ideas
- "Tips from collaborators / experts" section / chapter?
Discussions
- Should these new updates replace the current "Adding lints" chapter?
- Should they use an storytelling / informal style to welcome new users?
Lint passes: Re-write the current section (here) or create a whole new chapter? For this one take into account that this project is basically de-structuring the "Adding Lints" chapter into a lot of smaller ones, so creating a new chapter isn't a big deal.
For more detailed answer about these (or new) discussions, you can also create a comment and I'll add it here.
A lot of the discussion about this project was done through the draft PR #9426, but please, use this tracking issue instead.
Metadata
Metadata
Assignees
Labels
A-documentationArea: Adding or improving documentationArea: Adding or improving documentationC-tracking-issueCategory: Tracking IssueCategory: Tracking Issue
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
blyxyas commentedon Apr 5, 2023
@rustbot label C-tracking-issue A-documentation
xFrednet commentedon Apr 5, 2023
Yes, in my opinion they should. The current "Adding lints" grew over time and is now too long and not well-structured. There is no real separation between that and the "Common Tools" section. Reworking that would be a gigantic help
This depends on the part of the documentation. I like the storytelling style, but I know that I'm sometimes less formal than others in this project. Here I would put trust in the reviewer :)
Rewrite! The other PR already made some good progress on this. I would also like to put a focus on the
LateLintPass
as most lints should use that one :)Side note: I think the voting with emojis will not work too well. Requesting for text answers or asking in the next meeting might work better. :)
We sadly can't check every created issue due to the number of notifications, so it's likely that this issue has been missed by most. You can try to ping the Clippy team
@rust-lang/clippy
to get more feedback. A small note about this as well: Even if you ping us all, it's likely that you only get two or three responses. Don't let that discourage you, this usually means that the others agree with what has been said, don't have strong opinions on the matter, or in some cases, didn't have time to give detailed feedback. (It took me some time to learn this when I stated contribution. That's why I'm pointing that out early :))Btw, thank you for the issue and the detailed table :)
blyxyas commentedon Apr 5, 2023
Yeah voting with emojis won't go well, I noticed as soon as I wanted to create a fourth discussion 😅
blyxyas commentedon Apr 7, 2023
I found a problem with re-writing the current section on "Adding lints", if we're going to replace "Adding lints" with these new chapters, there won't really be an "Adding lints".
If Adding lints is going to be gone, creating a new chapter is quite literally the only way to go.
Auto merge of #10605 - blyxyas:book-type_checking, r=llogiq
blyxyas commentedon Apr 10, 2023
I think now is a pretty good moment to say that English isn't my first language...
Such a good idea to take revamping the documentation as a project...
xFrednet commentedon Apr 10, 2023
No worries, I believe that only one or two members have English as their mother tong. The reviews should catch simple mistakes :). If it's about spelling, I can highly recommend languagetool.org and the browser add-on. My spelling is... not perfect, but I'm fairly confident with that tool. I sadly don't know of a good IDE integration.
So please don't let this stop you!!
19 remaining items