rust-lang / rust-lang/rustfmt

Configure number of lines between module comments and module attributes

Open
#6,134 0 comments 0 reactions 0 assignees View on GitHub

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

It would be great if I could have an opinionated configuration for if there are lines between module //! Documentation and module #![attributes].

There could be perhaps One, Zero and Preserve.

Example code:

//! Some module documentation.


#![no_std]

With One:

//! Some module documentation.

#![no_std]

With Zero:

//! Some module documentation.
#![no_std]

and with Preserve (probably the default):

//! Some module documentation.


#![no_std]

Would this be possible? Could be a fun weekend PR for me to do as long as it's something the project would accept :)

Thanks!

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 tracing rustfmt's handling of module documentation and module attributes, then review existing formatting configuration options and tests. Add coverage for One, Zero, and Preserve behavior using the examples in the issue; done means each setting produces the specified spacing.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.