From 1e42de64af9560fe1de3c19473fecb241c8534af Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mart=C3=ADn=20Maita?=
 <47983254+mnmaita@users.noreply.github.com>
Date: Wed, 10 Mar 2021 01:00:55 +0000
Subject: [PATCH] Adds rustfmt configs to wrap and limit comment width (#1603)

Aims to close https://github.com/bevyengine/bevy/issues/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): https://github.com/rust-lang/rustfmt/issues/3347

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

[normalize_comments](https://rust-lang.github.io/rustfmt/?version=v1.4.36&search=#normalize_comments): https://github.com/rust-lang/rustfmt/issues/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: https://github.com/rust-lang/rustfmt/issues/3350). I can also add this configuration (commented out, of course) if it's desirable.~ Added `normalize_comments` option.
---
 rustfmt.toml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/rustfmt.toml b/rustfmt.toml
index f9e4d8ed54098..39a9ccb508133 100644
--- a/rustfmt.toml
+++ b/rustfmt.toml
@@ -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