Skip to content

Commit c2a446a

Browse files
author
Lukas Markeffsky
committed
rustdoc book: document single tilde strikethrough
1 parent 28ce0b9 commit c2a446a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/doc/rustdoc/src/how-to-write-documentation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,15 @@ extensions:
165165
### Strikethrough
166166

167167
Text may be rendered with a horizontal line through the center by wrapping the
168-
text with two tilde characters on each side:
168+
text with one or two tilde characters on each side:
169169

170170
```text
171-
An example of ~~strikethrough text~~.
171+
An example of ~~strikethrough text~~. You can also use ~single tildes~.
172172
```
173173

174174
This example will render as:
175175

176-
> An example of ~~strikethrough text~~.
176+
> An example of ~~strikethrough text~~. You can also use ~single tildes~.
177177
178178
This follows the [GitHub Strikethrough extension][strikethrough].
179179

0 commit comments

Comments
 (0)