about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/doc/rustdoc/src/how-to-write-documentation.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/how-to-write-documentation.md b/src/doc/rustdoc/src/how-to-write-documentation.md
index aaabaa6098f..acab1a93690 100644
--- a/src/doc/rustdoc/src/how-to-write-documentation.md
+++ b/src/doc/rustdoc/src/how-to-write-documentation.md
@@ -256,7 +256,8 @@ So, no need to manually enter those Unicode characters!
 
 ### Adding a warning block
 
-If you want to make a "warning" stand out in the documentation, you can wrap it like this:
+If you want to make a warning or similar note stand out in the documentation,
+you can wrap it like this:
 
 ```md
 /// documentation