Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bors merged 15 commits into from
Jun 23, 2023
Merged

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

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3747d7f
style-guide: Move text about block vs visual indent to indentation se…
joshtriplett Jun 22, 2023
9280567
style-guide: Move and expand text about trailing commas
joshtriplett Jun 22, 2023
2c0dd90
style-guide: s/right-ward/rightward/
joshtriplett Jun 22, 2023
4c5bb06
style-guide: Consistently refer to rustfmt as `rustfmt`
joshtriplett Jun 22, 2023
d270af3
style-guide: Remove inaccurate statement about rustfmt
joshtriplett Jun 22, 2023
c5f8b2c
style-guide: Define (and capitalize) "ASCIIbetically"
joshtriplett Jun 22, 2023
20f2828
style-guide: Update cargo.md for authors being optional and not recom…
joshtriplett Jun 22, 2023
6f8f83f
style-guide: Avoid normative recommendations for formatting tool conf…
joshtriplett Jun 22, 2023
fec28b2
style-guide: Clarify advice on names matching keywords
joshtriplett Jun 22, 2023
c930b21
style-guide: Reword an awkwardly phrased recommendation (and fix a typo)
joshtriplett Jun 22, 2023
3e2449c
style-guide: Rephrase a confusingly ordered, ambiguous sentence (and …
joshtriplett Jun 22, 2023
a9d1db3
style-guide: Avoid hyphenating "semicolon"
joshtriplett Jun 22, 2023
5d63721
style-guide: Make link text in SUMMARY.md match the headings in the l…
joshtriplett Jun 22, 2023
f972e09
style-guide: Define what an item is
joshtriplett Jun 22, 2023
fcc23a3
style-guide: Avoid referring to the style team in the past tense
joshtriplett Jun 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/doc/style-guide/src/advice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ if y {
* Local variables shall be `snake_case`,
* Macro names shall be `snake_case`,
* Constants (`const`s and immutable `static`s) shall be `SCREAMING_SNAKE_CASE`.
* When a name is forbidden because it is a reserved word (e.g., `crate`), use a
trailing underscore to make the name legal (e.g., `crate_`), or use raw
identifiers if possible.
* When a name is forbidden because it is a reserved word (such as `crate`),
either use a raw identifier (`r#crate`) or use a trailing underscore
(`crate_`). Don't misspell the word (`krate`).

### Modules

Expand Down