[libvirt PATCH 1/4] docs: Use consistent style in pci-addresses.rst

Daniel P. Berrangé berrange at redhat.com
Thu Apr 16 11:16:46 UTC 2020


On Thu, Apr 16, 2020 at 12:58:43PM +0200, Ján Tomko wrote:
> On a Wednesday in 2020, Andrea Bolognani wrote:
> > Indent all code snippets by the same number of spaces, and don't
> > embed the :: marker in the line preceding a code block.
> 
> But why? It's so ugly.

That aligns with the style we've used in all other rst docs we've
done so far.

Ideally we wouldn't use a bare "::" anyway - we really ought to be
using  ".. code-block:: $LANGUAGE" to instruct the renderer how to
highlight the code snippets. Our current website generator doesn't
use this, but hopefully we will in future

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 :|




More information about the libvir-list mailing list