From bfeab78ab5a0a62919ce8af0ad2f1f8a56032531 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 29 Feb 2016 15:00:40 +0200 Subject: Change doc styleguide to use quotes for notes [ci skip] --- doc/development/doc_styleguide.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 96d1dffbc52..187ec9e7b75 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -85,9 +85,19 @@ Inside the document: ## Notes -- Notes should be in italics with the word `Note:` being bold. Use this form: - `_**Note:** This is something to note._`. If the note spans across multiple - lines it's OK to split the line. +- Notes should be quoted with the word `Note:` being bold. Use this form: + + ``` + >**Note:** + This is something to note. + ``` + + which renders to: + + >**Note:** + This is something to note. + + If the note spans across multiple lines it's OK to split the line. ## New features -- cgit v1.2.1