style-guide: clean up "must"/"should"/"may" #113380

The style guide discusses the default Rust style. Configurability of Rust formatting tools are not the domain of the style guide.

The style guide requires a trailing comma on where clause components, but then gives an example that doesn't include one. Add the missing trailing comma.

…change) Avoid putting a sentence fragment after a list; integrate it with the sentence before the list.

…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.

Make it clear the rule for stacking the second line on the first applies recursively, as long as the condition holds.

…rustfmt) An example immediately following "Put each bound on its own line." did not put each bound on its own line.

Co-authored-by: Caleb Cartwright <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

style-guide: clean up "must"/"should"/"may" #113380

style-guide: clean up "must"/"should"/"may" #113380

Commits on Jul 21, 2023