Fix comments.
Some are too long, some aren't complete sentences, some are complete
sentences but don't bother with an upper case letter at the start. All
annoying and hurt readability.
diff --git a/rustfmt.toml b/rustfmt.toml
index 1f91496..4812c930 100644
--- a/rustfmt.toml
+++ b/rustfmt.toml
@@ -3,24 +3,24 @@
use_small_heuristics = "Max"
merge_derives = false
-# tidy only checks files which are not ignored, each entry follows gitignore style
+# Files to ignore. Each entry uses gitignore syntax.
ignore = [
"/build/",
"/*-build/",
"/build-*/",
"/vendor/",
- # tests for now are not formatted, as they are sometimes pretty-printing constrained
- # (and generally rustfmt can move around comments in UI-testing incompatible ways)
+ # Tests for now are not formatted, as they are sometimes pretty-printing constrained
+ # (and generally rustfmt can move around comments in UI-testing incompatible ways).
"/tests/*",
- # but we still want to format rmake.rs files in tests/run-make/ so we need to do this
- # dance to avoid the parent directory from being excluded
+ # But we still want to format rmake.rs files in tests/run-make/ so we need to do this
+ # dance to avoid the parent directory from being excluded.
"!/tests/run-make/",
"/tests/run-make/*/*.rs",
"!/tests/run-make/*/rmake.rs",
- # do not format submodules
+ # Do not format submodules.
# FIXME: sync submodule list with tidy/bootstrap/etc
# tidy/src/walk.rs:filter_dirs
"library/backtrace",
@@ -42,7 +42,7 @@
"src/tools/rustc-perf",
"src/tools/rustfmt",
- # these are ignored by a standard cargo fmt run
+ # These are ignored by a standard cargo fmt run.
"compiler/rustc_codegen_cranelift/scripts",
"compiler/rustc_codegen_cranelift/example/gen_block_iterate.rs", # uses edition 2024
]
