docs: Add section about code blocks to styleguide.rst

[libvirt PATCH] docs: Add section about code blocks to styleguide.rst

Andrea Bolognani posted 1 patch 5 years, 9 months ago

Download mbox

Test syntax-check failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20200416163825.94894-1-abologna@redhat.com

docs/styleguide.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)

Expand all Fold all

[libvirt PATCH] docs: Add section about code blocks to styleguide.rst

Posted by Andrea Bolognani 5 years, 9 months ago

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
---
 docs/styleguide.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/styleguide.rst b/docs/styleguide.rst
index 2998e90963..3162868fb7 100644
--- a/docs/styleguide.rst
+++ b/docs/styleguide.rst
@@ -24,6 +24,18 @@ Whitespace
 
 Blocks should be indented with 3 spaces, and no tabs
 
+Code blocks
+===========
+
+Code blocks should be created using
+
+::
+
+   This is regular text.
+
+   ::
+
+      This is a code block.
 
 Headings
 ========
-- 
2.25.2

Re: [libvirt PATCH] docs: Add section about code blocks to styleguide.rst

Posted by Daniel P. Berrangé 5 years, 9 months ago

On Thu, Apr 16, 2020 at 06:38:25PM +0200, Andrea Bolognani wrote:
> Signed-off-by: Andrea Bolognani <abologna@redhat.com>
> ---
>  docs/styleguide.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|