On Mon, Feb 05, 2024 at 08:46:57AM +0100, Markus Armbruster wrote: > The description of @bins ends with a literal block: > > # @bins: list of io request counts corresponding to histogram > # intervals, one more element than @boundaries has. For the > # example above, @bins may be something like [3, 1, 5, 2], and > # corresponding histogram looks like: > # > # :: > # > # 5| * > > Except it actually ends *before* the block: the unindented '::' line > starts a new section. Makes no sense. > > We could fix this by indenting the '::' line. Instead, double the > colon at the end of the preceding paragraph, and drop the '::' line. > > This shifts the box for the literal block right in generated > documentation, so it lines up with the description. > > Fixes: commit a0fcff383b34 (qapi: Use rST markup for literal blocks) > Signed-off-by: Markus Armbruster <arm...@redhat.com> > --- > qapi/block-core.json | 4 +--- > 1 file changed, 1 insertion(+), 3 deletions(-)
Reviewed-by: Daniel P. Berrangé <berra...@redhat.com> With 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 :|
