From ce85eb2ccd3143979463cdcd6edccf946e1a5f5a Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 21 Nov 2018 10:33:37 +0000 Subject: [PATCH] docs: Add warnings to doc requirements doc Document how other admonitions such as warnings and hints should be handled. Fixes #307. Signed-off-by: James O. D. Hunt --- Documentation-Requirements.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Documentation-Requirements.md b/Documentation-Requirements.md index 5a911a141a..29f32405f6 100644 --- a/Documentation-Requirements.md +++ b/Documentation-Requirements.md @@ -1,6 +1,7 @@ * [Introduction](#introduction) * [General requirements](#general-requirements) * [Notes](#notes) +* [Warnings and other admonitions](#warnings-and-other-admonitions) * [Files and command names](#files-and-command-names) * [Code blocks](#code-blocks) * [Images](#images) @@ -35,6 +36,24 @@ If there are multiple notes, bullets should be used: > > - I am important point *n*. +# Warnings and other admonitions + +Use the same approach as for [notes](#notes). For example: + +> **Warning:** Running this command assumes you understand the risks of doing so. + +Other examples: + +> **Warnings:** +> +> - Do not unplug your computer! +> - Always read the label. +> - Do not pass go. Do not collect $200. + +> **Tip:** Read the manual page for further information on available options. + +> **Hint:** Look behind you! + # Files and command names All filenames and command names should be rendered in a fixed-format font