rustfmt indents leading section comments to match code indentation, breaking intentional left-aligned vertical alignment
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
rustfmt indents leading section comments to match code indentation, breaking intentional left-aligned vertical alignment
.with_quic_config(|mut cfg| {
// ===== Connection Lifespan =====
cfg.keep_alive_interval = Duration::from_secs(5);
cfg.max_idle_timeout = 30_000; // ms (30 seconds)
// ===== Concurrent Stream Limit (QUIC Layer) =====
cfg.max_concurrent_stream_limit = 10_000;
// ===== Flow Control =====
cfg.max_stream_data = 100 * 1024;
cfg.max_connection_data = 20 * 1024;
// ===== Protocol Compatibility =====
cfg.support_draft_29 = true;
cfg
})
After running cargo fmt, the comments are indented to match the surrounding code block:
.with_quic_config(|mut cfg| {
// ===== Connection Lifespan =====
cfg.keep_alive_interval = Duration::from_secs(5);
cfg.max_idle_timeout = 30_000; // ms (30 seconds)
// ===== Concurrent Stream Limit (QUIC Layer) =====
cfg.max_concurrent_stream_limit = 100;
// ===== Flow Control =====
cfg.max_stream_data = 100 * 1024;
cfg.max_connection_data = 20 * 1024;
// ===== Protocol Compatibility =====
cfg.support_draft_29 = true;
cfg
})
// ==== Concurrent Stream Limit (QUIC Layer) ==== is not left-aligned
can you optimize this problem?
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 reported formatting change with cargo fmt using the Rust snippet in the issue. Trace how rustfmt handles the leading section comment after the inline comment, then add coverage for this case if the relevant test location is found. Done means cargo fmt preserves the comment’s intended left alignment without changing other formatting.
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
- 42/100