rust-lang / rust-lang/edition-guide
Feedback on the 2024 edition import sorting page
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 324
- Forks
- 152
- PR merge metrics
- No merged PRs in 30d
Description
I just saw the new blog post and followed the link at the bottom and ended up on this page: https://doc.rust-lang.org/nightly/edition-guide/rust-2024/rustfmt-version-sorting.html. I have some feedback on the page.
The page mentions that the sorting now has better sorting for types with numbers in their name which I appreciate. Shown in the diff but not mentioned anywhere in the text is that lower-case names suddenly move from the front to the back, as seen by the std::io::stdout import in that example. I believe this change should be more clearly mentioned in the text as it can be quite a surprise to see that suddenly all your imports get shuffled around. It is also a change that creates a lot of unnecessary diff and one I'd like to not have (while still keeping all the other great changes in the new style edition), so if there is a flag to disable this behaviour it would be cool if that was documented as well.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Edition Guide import-sorting page and locate its source in the repository. Update the explanation to mention lowercase names moving to the back and document any available option to disable that behavior; done means the rendered page accurately covers both points.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100