about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-06-22 13:17:47 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-06-22 13:19:05 -0700
commit6f8f83f66d88afe1e7d40011f8862844d8fa86c4 (patch)
treeeadf7cb9bccd7c82d14da765e58eb17be6e70e83
parent20f2828bbd37ce3d91797a2f2243c76190856301 (diff)
downloadrust-6f8f83f66d88afe1e7d40011f8862844d8fa86c4.tar.gz
rust-6f8f83f66d88afe1e7d40011f8862844d8fa86c4.zip
style-guide: Avoid normative recommendations for formatting tool configurability
It's not within the scope of the style guide to tell formatting tools
whether, or how, to allow configurability of non-default formatting.
-rw-r--r--src/doc/style-guide/src/README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/src/doc/style-guide/src/README.md b/src/doc/style-guide/src/README.md
index 78e1d6a1fa1..2ad834f804b 100644
--- a/src/doc/style-guide/src/README.md
+++ b/src/doc/style-guide/src/README.md
@@ -28,7 +28,7 @@ formatting, typically by using a formatting tool's default settings.
 * Each level of indentation must be four spaces (that is, all indentation
   outside of string literals and comments must be a multiple of four).
 * The maximum width for a line is 100 characters.
-* A tool should be configurable for all three of these variables.
+* A tool may choose to make some of these configurable.
 
 #### Block indent
 
@@ -87,11 +87,7 @@ fn bar() {}
 fn baz() {}
 ```
 
-Formatting tools should make the bounds on blank lines configurable: there
-should be separate minimum and maximum numbers of newlines between both
-statements and (top-level) items (i.e., four options). As described above, the
-defaults for both statements and items should be minimum: 1, maximum: 2.
-
+Formatting tools may wish to make the bounds on blank lines configurable.
 
 ### [Module-level items](items.md)
 ### [Statements](statements.md)