Skip to content

Commit b922253

Browse files
authored
Rollup merge of rust-lang#85668 - ehuss:fix-rustdoc-tasklist, r=Mark-Simulacrum
Fix tasklist example in rustdoc book. There were a few issues with the tasklist example in the rustdoc book: * Misspelled "incomplete" * Checkmarks were backwards * Didn't show the text for each item * Used HTML which renders differently from how markdown renders it (which uses "disabled" marks) * Didn't use blockquotes to offset the example like the other extensions do * Missing a colon Before: <img width="160" alt="image" src="https://user-images.githubusercontent.com/43198/119503519-e7787880-bd1f-11eb-9f13-1c67754ce001.png"> After: <img width="220" alt="image" src="https://user-images.githubusercontent.com/43198/119503449-d6c80280-bd1f-11eb-9ab5-fe4a6df82124.png">
2 parents 95ca859 + 79a5b12 commit b922253

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

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

+4-6
Original file line numberDiff line numberDiff line change
@@ -229,15 +229,13 @@ Example:
229229

230230
```md
231231
- [x] Complete task
232-
- [ ] IncComplete task
232+
- [ ] Incomplete task
233233
```
234234

235-
This will render as
235+
This will render as:
236236

237-
<ul>
238-
<li><input type="checkbox"></li>
239-
<li><input type="checkbox" checked></li>
240-
</ul>
237+
> - [x] Complete task
238+
> - [ ] Incomplete task
241239
242240
See the specification for the [task list extension] for more details.
243241

0 commit comments

Comments
 (0)