about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLukas Markeffsky <@>2023-05-25 13:29:39 +0000
committerLukas Markeffsky <@>2023-05-25 13:29:39 +0000
commitc2a446a95ec503436930dba2408a9c36953ba19f (patch)
treed68f72b178d86135cdbf9ecdffebdbc92a20f540
parent28ce0b9940f985e32890b8997dd1406705dde55f (diff)
downloadrust-c2a446a95ec503436930dba2408a9c36953ba19f.tar.gz
rust-c2a446a95ec503436930dba2408a9c36953ba19f.zip
rustdoc book: document single tilde strikethrough
-rw-r--r--src/doc/rustdoc/src/how-to-write-documentation.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/doc/rustdoc/src/how-to-write-documentation.md b/src/doc/rustdoc/src/how-to-write-documentation.md
index 38fd1db5c21..1fa9f814476 100644
--- a/src/doc/rustdoc/src/how-to-write-documentation.md
+++ b/src/doc/rustdoc/src/how-to-write-documentation.md
@@ -165,15 +165,15 @@ extensions:
 ### Strikethrough
 
 Text may be rendered with a horizontal line through the center by wrapping the
-text with two tilde characters on each side:
+text with one or two tilde characters on each side:
 
 ```text
-An example of ~~strikethrough text~~.
+An example of ~~strikethrough text~~. You can also use ~single tildes~.
 ```
 
 This example will render as:
 
-> An example of ~~strikethrough text~~.
+> An example of ~~strikethrough text~~. You can also use ~single tildes~.
 
 This follows the [GitHub Strikethrough extension][strikethrough].