Skip to content

Commit

Permalink
style-guide: Avoid normative recommendations for formatting tool conf…
Browse files Browse the repository at this point in the history
…igurability

It's not within the scope of the style guide to tell formatting tools
whether, or how, to allow configurability of non-default formatting.
  • Loading branch information
joshtriplett committed Jun 22, 2023
1 parent 20f2828 commit 6f8f83f
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions src/doc/style-guide/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 6f8f83f

Please sign in to comment.