style-guide: Organizational and editing tweaks (no semantic changes) #112942

…ction `principles.md` includes some high-level guiding principles for formatting, but also includes a few specific formatting provisions. While those provisions apply in many places, the same holds true for other high-level guidance, such as the indentation section. Move the text about using block indent rather than visual indent to the indentation section, so that `principles.md` can focus on guiding principles while the top level of the style guide gives concrete formatting recommendations.

`principles.md` includes some high-level guiding principles for formatting, but also includes a few specific formatting provisions. While those provisions apply in many places, the same holds true for other high-level guidance. Move the text about trailing commas to `README.md`, so that `principles.md` can focus on guiding principles while the top level of the style guide gives concrete formatting recommendations.

We already use the word "rightward" elsewhere; avoid the unnecessarily hyphenated "right-ward".

rustfmt does include a mechanism to distinguish standard library imports, which it does syntactically by crate name. Avoid making a misleading statement that implies it cannot do this.

The style guide didn't give any definition for it.

…mended Change an example using the authors field to use a long feature list instead. Change the conventions for the authors field to say "if present".

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

In particular, specify what this advice is an alternative to (creative misspellings such as `krate`).

…fix a typo) This sentence had a parenthetical without a closing parenthesis, and had the phrase "which doesn't require special formatting" ambiguously at the end of a list when it only applied to the last item of the list.

…inked pages

We live!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

style-guide: Organizational and editing tweaks (no semantic changes) #112942

style-guide: Organizational and editing tweaks (no semantic changes) #112942

Commits on Jun 22, 2023