rust-lang / rust-lang/reference
Slowly convert reference to one sentence is one line
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
Instead of wrapping paragraphs at 80 characters, each sentence should be on one line.
There's not enough bandwidth to convert the entire reference at once, so PRs that touch a page substantially should switch the style. Do not allow mixed style on the same page; either do an entire page or none at all. Also, do so as a separate commit so it doesn't drown out other changes. Maybe even send in a PR that just does that and send in the substantial change based on the commit of that PR.
- Update the style guide. #980
Contributor guide
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
Start by reviewing the style guide update referenced in #980 and identify Reference pages that still wrap paragraphs at 80 characters. Convert a complete page rather than mixing styles, and keep the formatting work in a separate commit; done means the selected page consistently uses one sentence per line.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100