From fec28b26b5b6252cdd153135d61f54de4f2d10fb Mon Sep 17 00:00:00 2001
From: Josh Triplett <josh@joshtriplett.org>
Date: Thu, 22 Jun 2023 13:21:40 -0700
Subject: [PATCH] style-guide: Clarify advice on names matching keywords
In particular, specify what this advice is an alternative to (creative
misspellings such as `krate`).
---
src/doc/style-guide/src/advice.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/doc/style-guide/src/advice.md b/src/doc/style-guide/src/advice.md
index ab4b92b0a24..9a617be509c 100644
--- a/src/doc/style-guide/src/advice.md
+++ b/src/doc/style-guide/src/advice.md
@@ -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