rust-lang / rust-lang/rustfmt

Comment after last || branch in an if clause is forced to a separate line

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

Nobody has claimed this yet.

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

Description

This code:

if lower.contains("expiry date:")
|| lower.contains("expires:") /* .am, .br, .dk, .edu, .is, .lt, .se, .ua */
|| lower.contains("expire:") /* .ar, .cz */
{
	// ...
}

is formatted to:

if lower.contains("expiry date:")
|| lower.contains("expires:") /* .am, .br, .dk, .edu, .is, .lt, .se, .ua */
|| lower.contains("expire:")
/* .ar, .cz */
{
	// ...
}

Supposedly rustfmt is assuming the comment between if and { is comment for the entire if clause. Ideally it should take || into account and take the comment before { as comment for the last || branch. (Probably also &&)

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 reproducing the formatting change with the Rust snippet in the issue, then trace rustfmt's handling of comments between the final condition and the opening brace. Done means the comment remains associated with the last || branch, with analogous behavior considered for &&.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.