about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume.gomez@huawei.com>2023-01-07 14:50:03 +0100
committerGuillaume Gomez <guillaume.gomez@huawei.com>2023-08-14 13:51:41 +0200
commit1d42913058d4005655ea51b2d9dde707791c6541 (patch)
treeac839f465e1248a0087333489a01ffa3ba0678bc /src/doc/rustdoc
parent57d2b84a57225717c6af8748574b4a847d62433c (diff)
downloadrust-1d42913058d4005655ea51b2d9dde707791c6541.tar.gz
rust-1d42913058d4005655ea51b2d9dde707791c6541.zip
Add GUI test for warning blocks
Diffstat (limited to 'src/doc/rustdoc')
-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