Improve documentation for using warning blocks in documentation #119245
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
the
S-waiting-on-review
fmease
approved these changes
Dec 23, 2023
| be interpreted as such, you need to have an empty line between the HTML tags | ||
| and your markdown content. For example if you want to use a link: | ||
|
|
||
| ```md |
There was a problem hiding this comment.
I'm kinda surprised that we use md instead of rs given the /// at the start of the line but I get that that probably leads to better highlighting (it's also used that way above).
I've just noticed that we use text for a lot of markdown snippets in this file, should probably be changed at some point 🤔
|
r? fmease @bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 23, 2023
…iaskrgr Rollup of 5 pull requests Successful merges: - rust-lang#119231 (Clairify `ast::PatKind::Struct` presese of `..` by using an enum instead of a bool) - rust-lang#119232 (Fix doc typos) - rust-lang#119245 (Improve documentation for using warning blocks in documentation) - rust-lang#119248 (remove dead inferred outlives testing code) - rust-lang#119249 (Add spastorino to users_on_vacation) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 23, 2023
Rollup merge of rust-lang#119245 - GuillaumeGomez:improve-docs, r=fmease Improve documentation for using warning blocks in documentation From [this comment](rust-lang#79710 (comment)), I think markdown can be surprising sometimes so better explain a bit better how to use it correctly. r? `@notriddle`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From this comment, I think markdown can be surprising sometimes so better explain a bit better how to use it correctly.
r? @notriddle