Skip to content

Commit

Permalink
Adds rustfmt configs to wrap and limit comment width (#1603)
Browse files Browse the repository at this point in the history
Aims to close #1594.

These options are unstable and depend on the following PR's:

[wrap_comments](https://rust-lang.github.io/rustfmt/?version=v1.4.36&search=#wrap_comments): rust-lang/rustfmt#3347

[comment_width](https://rust-lang.github.io/rustfmt/?version=v1.4.36&search=#comment_width): rust-lang/rustfmt#3349

[normalize_comments](https://rust-lang.github.io/rustfmt/?version=v1.4.36&search=#normalize_comments): rust-lang/rustfmt#3350

@alice-i-cecile do you think this will solve the issue? When enabled, running the formatter locally should take the configurations into account to format comments. `--check` runs should also be considering them. This should be testable on the `nightly` toolchain.

~I didn't delve into normalizing `//` vs `/* */` though, should I take a look into that too? [normalize_comments](https://rust-lang.github.io/rustfmt/?version=v1.4.36&search=#normalize_comments) seems to be the solution for that but it's also unstable (tracking issue: rust-lang/rustfmt#3350). I can also add this configuration (commented out, of course) if it's desirable.~ Added `normalize_comments` option.
  • Loading branch information
mnmaita committed Mar 10, 2021
1 parent e9a501e commit 1e42de6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ newline_style = "Unix"
#unstable_features = true
#imports_granularity = "Crate"
#reorder_impl_items = true
#wrap_comments = true
#comment_width = 100
#normalize_comments = true

0 comments on commit 1e42de6

Please sign in to comment.