From 914a9f6fba89a9a30d1112d517b63d6c695f6c4a Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Tue, 15 Dec 2015 14:13:25 +0530 Subject: [PATCH] [common-rst] Modifications in conventions.rst In this patch I added a 'caution' in conventions list and also modified the explanation for note Reason: The 'caution' is used in the file admin-guide-cloud/source/blockstorage-driver-filter-weighing.rst Change-Id: Ibb1aafad9d7668c666638622d9283a94ad180558 --- doc/common-rst/conventions.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/common-rst/conventions.rst b/doc/common-rst/conventions.rst index 5bc8fa2afa..e6b70bf69b 100644 --- a/doc/common-rst/conventions.rst +++ b/doc/common-rst/conventions.rst @@ -9,14 +9,17 @@ Notices Notices take these forms: -.. note:: A handy tip or reminder. +.. note:: A comment with additional information that explains a part of the + text. .. important:: Something you must be aware of before proceeding. .. tip:: An extra but helpful piece of practical advice. +.. caution:: Helpful information that prevents the user from making mistakes. + .. warning:: Critical information about the risk of data loss or security - issues. + issues. Command prompts ~~~~~~~~~~~~~~~