rustfmt removes comments from visibility annotation
Open
Nobody has claimed this yet.
A-comments
C-bug
I-unexpectedly-removes-code
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Noticed a few times
-pub(crate /* important comment */) fn add(left: u64, right: u64) -> u64 {
+pub(crate) fn add(left: u64, right: u64) -> u64 {
left + right
}
There seem to be a lot of issues related to comments but I couldn't find this specific one after some basic searching.
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 visibility-annotation snippet in rustfmt and trace how that syntax is formatted. Locate the relevant formatter tests and add a regression case showing that the comment is preserved; the work is done when rustfmt retains the comment and the regression test passes.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100