rust-lang / rust-lang/rustfmt

Rustfmt deletes comments in first position of trait bound

Open
#6,051 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-comments C-bug I-unexpectedly-removes-code
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Example code:

    pub fn try_new_with_date_length_unstable<P>(
        provider: &P,
        locale: &DataLocale,
        length: length::Date,
    ) -> Result<Self, Error>
    where
        P: // Explanatory comment about the bounds
            ?Sized
            + DataProvider<BuddhistDatePatternV1Marker>
            + DataProvider<BuddhistYearNamesV1Marker>
            + DataProvider<BuddhistMonthNamesV1Marker>
    { ... }

Running this through rustfmt deletes the // Explanatory comment about the bounds.

Workaround: move the ?Sized into the first position. If your bound is not ?Sized, you can use Sized. The comment is retained:

    pub fn try_new_with_date_length_unstable<P>(
        provider: &P,
        locale: &DataLocale,
        length: length::Date,
    ) -> Result<Self, Error>
    where
        P: ?Sized
            // Explanatory comment about the bounds
            + DataProvider<BuddhistDatePatternV1Marker>
            + DataProvider<BuddhistYearNamesV1Marker>
            + DataProvider<BuddhistMonthNamesV1Marker>
    { ... }

Possibly related to https://github.com/rust-lang/rustfmt/issues/3669, https://github.com/rust-lang/rustfmt/pull/4666, https://github.com/rust-lang/rustfmt/pull/5059 but the examples are in different contexts so I thought I would file a new issue with this test case.

CC @Manishearth

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

Reproduce the reported trait-bound example with rustfmt, then inspect the related issues and pull requests linked in the report for context. The work is done when the explanatory comment is preserved in this form and a regression test covers the case.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.