Add documentation for warning blocks in rustdoc book

This commit is contained in:
Guillaume Gomez 2023-01-07 14:49:11 +01:00
parent d51521e280
commit 57d2b84a57
1 changed files with 12 additions and 0 deletions

View File

@ -254,6 +254,18 @@ characters:
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:
```md
/// documentation
///
/// <div class="warning">A big warning!</div>
///
/// more documentation
```
[`backtrace`]: https://docs.rs/backtrace/0.3.50/backtrace/
[commonmark markdown specification]: https://commonmark.org/
[commonmark quick reference]: https://commonmark.org/help/