about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2022-11-16 13:14:09 -0800
committerJosh Triplett <josh@joshtriplett.org>2022-11-16 13:14:09 -0800
commitd6f88b544d3ee219c20ca487b309e3e76c7d0cfd (patch)
tree5d63f891c5893bf49de74458d854ed3c42d87d12
parente69336efe035c274f2ee66922cd9cac6015956ea (diff)
downloadrust-d6f88b544d3ee219c20ca487b309e3e76c7d0cfd.tar.gz
rust-d6f88b544d3ee219c20ca487b309e3e76c7d0cfd.zip
Expand a style-guide principle: readability in plain text
-rw-r--r--src/doc/style-guide/src/principles.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/doc/style-guide/src/principles.md b/src/doc/style-guide/src/principles.md
index b02b3c0471f..21668973194 100644
--- a/src/doc/style-guide/src/principles.md
+++ b/src/doc/style-guide/src/principles.md
@@ -8,7 +8,9 @@ following principles (in rough priority order):
     - avoiding misleading formatting
     - accessibility - readable and editable by users using the the widest
       variety of hardware, including non-visual accessibility interfaces
-    - readability of code when quoted in rustc error messages
+    - readability of code in contexts without syntax highlighting or IDE
+      assistance, such as rustc error messages, diffs, grep, and other
+      plain-text contexts
 
 * aesthetics
     - sense of 'beauty'