You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is backwards from generally accepted practice for precautionary statements in technical documentation, where a "warning" statement is considered more serious than a "caution" statement (and "danger" is considered most serious).
When choosing the admonition type, you may find yourself getting confused between "caution" and "warning" as these words are often used interchangeably. Here’s a simple rule to help you differentiate the two:
Use CAUTION to advise the reader to act carefully (i.e., exercise care).
Use WARNING to inform the reader of danger, harm, or consequences that exist.
The colors and icons used for Caution and Warning in GitHub alerts imply that Caution (red) is more serious than Warning (yellow).
From https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts:
This is backwards from generally accepted practice for precautionary statements in technical documentation, where a "warning" statement is considered more serious than a "caution" statement (and "danger" is considered most serious).
ANSI Z535.5
OSHA 1910.145
From https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/:
Some other examples:
The text was updated successfully, but these errors were encountered: