[Feature Request] Maintain newlines between crate-level attributes
Open
Nobody has claimed this yet.
C-feature-request
P-low
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Given the following code:
//! Foobar
#![doc = "baz"]
// Allow some lints
#![allow(unknown_lints)]
...rustfmt removes the newline separating the crate-level doc comment from the next block:
//! Foobar
#![doc = "baz"]
// Allow some lints
#![allow(unknown_lints)]
IMO this is the wrong behavior; in my particular use case, I intended to logically separate the crate-level doc comment from other crate-level attributes.
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 snippet in the report and trace rustfmt's handling of crate-level attributes. Preserve the blank line between the crate-level documentation and later attributes, and add a regression test covering the shown input and output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100