Trailing space line breaks are removed from doc comments
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Consider this:
/*!
This
has
breaks.
*/
Note the two trailing spaces at each of lines 2 and 3. These are line breaks according to the Markdown specification. Unfortunately, rustfmt treats them as an accident and removes them.
The alternative markup here is <br/>, which is HTML-specific and harder to read, but won't be eaten by rustfmt.
I would recommend allowing exactly two spaces at the end of a line in doc comments, under the assumption that this is intended.
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 locating rustfmt's doc-comment formatting logic and existing tests for trailing whitespace. Reproduce the Markdown example, then verify that exactly two trailing spaces are preserved while unrelated formatting remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100