about summary refs log tree commit diff
path: root/compiler/rustc_interface/src
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-06-28 16:56:53 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-07-20 17:57:18 -0700
commitce5aca9f5a1726ef892f0feca34ba5454c164857 (patch)
treef74560fcfe2127cd74370ea6997fca32be3ca537 /compiler/rustc_interface/src
parent081e15a0d81b8feba7e72bb7955543008a89bda0 (diff)
downloadrust-ce5aca9f5a1726ef892f0feca34ba5454c164857.tar.gz
rust-ce5aca9f5a1726ef892f0feca34ba5454c164857.zip
style-guide: Avoid using "should" or "may" for required parts of the default style
The style guide inconsistently used language like "there should be a
space" or "it should be on its own line", or "may be written on a single
line", for things that are required components of the default Rust
style. "should" and especially "may" come across as optional. While the
style guide overall now has a statement at the top that the default
style itself is a *recommendation*, the *definition* of the default
style should not be ambiguous about what's part of the default style.

Rewrite language in the style guide to only use "should" and "may" and
similar for truly optional components of the style (e.g. things a tool
cannot or should not enforce in its default configuration).

In their place, either use "must", or rewrite in imperative style ("put
a space", "start it on the same line"). The latter also substantially
reduces the use of passive voice.

This is a purely editorial change, and does not affect the semantic
definition of the Rust style.
Diffstat (limited to 'compiler/rustc_interface/src')
0 files changed, 0 insertions, 0 deletions