mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style-guide: Add language disclaiming any effects on non-default Rust styles

Browse Source 
Make it clear that the style guide saying "must" doesn't forbid
developers from doing differently (as though any power on this Earth
could do that) and doesn't forbid tools from allowing any particular
configuration options.
This commit is contained in:
Josh Triplett 2023-06-22 14:39:15 -07:00
parent 04075b3202
commit 2748efaba3
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/doc/style-guide/src/README.md
View File

@ -19,6 +19,18 @@ Thus, there are productivity benefits to using a formatting tool (such as
rustfmt), and even larger benefits by using a community-consistent formatting,
typically by using a formatting tool's default settings.
## The default Rust style
The Rust Style Guide defines the default Rust style, and *recommends* that
developers and tools follow the default Rust style. Tools such as `rustfmt` use
the style guide as a reference for the default style. Everything in this style
guide, whether or not it uses language such as "must" or the imperative mood
such as "insert a space ..." or "break the line after ...", refers to the
default style.
This should not be interpreted as forbidding developers from following a
non-default style, or forbidding tools from adding any particular configuration
options.
## Formatting conventions