about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-06-22 12:45:56 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-06-22 12:49:49 -0700
commit4c5bb06a97515c1135e9339e6fa1fd78e7531ba2 (patch)
treed9ed3f2aca819eacddea30a70cec9fb648fd5b5a
parent2c0dd90936a5ce6a61cbe0f342b452871409b71c (diff)
downloadrust-4c5bb06a97515c1135e9339e6fa1fd78e7531ba2.tar.gz
rust-4c5bb06a97515c1135e9339e6fa1fd78e7531ba2.zip
style-guide: Consistently refer to rustfmt as `rustfmt`
-rw-r--r--src/doc/style-guide/src/README.md4
-rw-r--r--src/doc/style-guide/src/items.md4
-rw-r--r--src/doc/style-guide/src/principles.md2
3 files changed, 5 insertions, 5 deletions
diff --git a/src/doc/style-guide/src/README.md b/src/doc/style-guide/src/README.md
index 3d47e33841a..78e1d6a1fa1 100644
--- a/src/doc/style-guide/src/README.md
+++ b/src/doc/style-guide/src/README.md
@@ -16,8 +16,8 @@ Rust code has similar formatting, less mental effort is required to comprehend a
 new project, lowering the barrier to entry for new developers.
 
 Thus, there are productivity benefits to using a formatting tool (such as
-rustfmt), and even larger benefits by using a community-consistent formatting,
-typically by using a formatting tool's default settings.
+`rustfmt`), and even larger benefits by using a community-consistent
+formatting, typically by using a formatting tool's default settings.
 
 
 ## Formatting conventions
diff --git a/src/doc/style-guide/src/items.md b/src/doc/style-guide/src/items.md
index 2835975355f..a9c559d0bb8 100644
--- a/src/doc/style-guide/src/items.md
+++ b/src/doc/style-guide/src/items.md
@@ -505,8 +505,8 @@ use b;
 Because of `macro_use`, attributes must also start a new group and prevent
 re-ordering.
 
-Note that tools which only have access to syntax (such as Rustfmt) cannot tell
-which imports are from an external crate or the std lib, etc.
+Note that tools which only have access to syntax (such as `rustfmt`) cannot
+tell which imports are from an external crate or the std lib, etc.
 
 
 #### Ordering list import
diff --git a/src/doc/style-guide/src/principles.md b/src/doc/style-guide/src/principles.md
index 30fb26014f2..bbf6d76d421 100644
--- a/src/doc/style-guide/src/principles.md
+++ b/src/doc/style-guide/src/principles.md
@@ -24,6 +24,6 @@ following principles (in rough priority order):
 
 * application
     - ease of manual application
-    - ease of implementation (in Rustfmt, and in other tools/editors/code generators)
+    - ease of implementation (in `rustfmt`, and in other tools/editors/code generators)
     - internal consistency
     - simplicity of formatting rules