Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Caution and Warning alerts are backwards from generally accepted practice #1865

Open
cdwilson opened this issue Aug 25, 2024 · 0 comments
Open

Comments

@cdwilson
Copy link

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:

image

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

image

OSHA 1910.145

image

From https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/:

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.

Some other examples:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant