rust-lang / rust-lang/rustfmt

Rustfmt misaligns doc comment between rustfmt::skip modules

Open
#6,176 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-comments A-rustfmt::skip
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

mod modules {
    #[rustfmt::skip]
    #[path = "/dev/null"]
    mod first;

    /// ...
    /// ...
    #[rustfmt::skip]
    #[path = "/dev/null"]
    mod second;
}

Running rustfmt on this file turns it into:

mod modules {
    #[rustfmt::skip]
    #[path = "/dev/null"]
    mod first; /// ...
               /// ...
    #[rustfmt::skip]
    #[path = "/dev/null"]
    mod second;
}
<     mod first;
<
<     /// ...
<     /// ...
---
>     mod first; /// ...
>                /// ...

Observations:

  • The #[path = "/dev/null"] attribute is not necessary for the repro. It is just to make this reproducible with a single input file.
  • Both #[rustfmt::skip] are necessary for the repro. Without either one, the problem does not occur.
  • Both ; are necessary for the repro. If either module uses {} instead of ;, the problem does not occur.
  • The outer module is necessary.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running rustfmt on the single-file Rust example in the issue and confirm the doc comments move onto the first skipped module. Trace rustfmt's handling of consecutive #[rustfmt::skip] modules and their doc comments. Done means formatting preserves the comments as separate lines before the second module without changing the surrounding code.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.