-
Notifications
You must be signed in to change notification settings - Fork 5
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 should be reversed #4
Comments
The colours for Note and Important should probably be reversed, too... |
Interesting, didn't think about caution vs warning. I'll switch them soon. However, since this is just a CSS matter and really beyond the scope of this library (I'm just providing a way to implement them in markdown, but CSS styling is completely customizable) I'll leave note and important as they are, maybe adding a line on how to change them in the doc. Furthermore, this means you can just swap them right now if you're using the lib in your project, hope this will help. Thank you for the info |
Thanks for the feedback! I like the approach you're suggesting. |
The visual presentation of Caution and Warning imply that a Caution is more important than a Warning. This is the opposite of generally accepted practice.
OSHA: https://en.wikipedia.org/wiki/Precautionary_statement
Aviation: http://www.tc.gc.ca/eng/civilaviation/standards/commerce-manuals-multicrewsop-chapter1-section7-1813.htm
General technical documentation advice: https://www.technicalcommunicationcenter.com/2016/11/04/notes-cautions-and-warnings-in-technical-writing/
The text was updated successfully, but these errors were encountered: