normalize_doc_attributes + wrap_comments can leave trailing whitespace
Open
Nobody has claimed this yet.
A-doc-comments
C-bug
I-trailing-whitespace
UO-normalize_doc_attributes
UO-wrap_comments
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Summary
I tried to format this code:
// rustfmt-normalize_doc_attributes: true
// rustfmt-wrap_comments: true
pub trait ClientSystemAlertsExt {
#[doc = "If this is included, only alerts created at or after this time will be returned.\n```ignore\nx\n```"]
fn alert_list(&self) -> builder::AlertList<'_>;
}
Expected behavior
No trailing whitespace in any line (and no changes after running rustfmt on the formatted code i.e. idempotency).
Actual behavior
Trailing whitespace after " returned."
Configuration
As noted above: normalize_doc_attributes + wrap_comments
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 reproducing the issue with the Rust trait and the normalize_doc_attributes and wrap_comments options shown in the report. Trace how the documentation string is normalized and wrapped; the work is done when no line has trailing whitespace and formatting the result again makes no changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100