summaryrefslogtreecommitdiff
path: root/rustfmt.toml
diff options
context:
space:
mode:
authorNicholas Nethercote <n.nethercote@gmail.com>2024-05-28 10:36:37 +1000
committerNicholas Nethercote <n.nethercote@gmail.com>2024-05-28 19:28:21 +1000
commit4702a1c345f1c13e13bdbe9bb3fdb81d6f866d85 (patch)
treeff5d3e856ca55c3f893d6972c0b914f88eec52fd /rustfmt.toml
parentbcfa67d50d29bbe99ef0ee4d41838e6bdd651b68 (diff)
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.
Diffstat (limited to 'rustfmt.toml')
-rw-r--r--rustfmt.toml14
1 files changed, 7 insertions, 7 deletions
diff --git a/rustfmt.toml b/rustfmt.toml
index 1f914964e24..4812c9302df 100644
--- a/rustfmt.toml
+++ b/rustfmt.toml
@@ -3,24 +3,24 @@ version = "Two"
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 @@ ignore = [
"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
]