[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for b
From: |
Peter Maydell |
Subject: |
Re: [PATCH v6 02/21] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set |
Date: |
Mon, 28 Sep 2020 13:49:22 +0100 |
On Mon, 28 Sep 2020 at 13:42, Markus Armbruster <armbru@redhat.com> wrote:
>
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > The block-latency-histogram-set command is the only one which uses
> > the Example/Examples section with the first line of the documentation
> > immediately following the ':'. Bring it into line with the rest.
> >
> > This allows us to avoid special-casing the indentation handling for
> > "Examples" sections; instead for Examples as for any other section
> > header these two indentations will be equivalent:
>
> I figure you're talking about PATCH 5 here. Correct?
>
> If yes, I'd like to tweak this to "This will allow us". Okay?
Sure. (In my idiolect both those phrasings have pretty much
identical meaning in this context.)
thanks
-- PMM
- [PATCH v6 00/21] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/09/25
- [PATCH v6 01/21] qapi: Fix doc comment indentation again, Peter Maydell, 2020/09/25
- [PATCH v6 03/21] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/09/25
- [PATCH v6 04/21] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/09/25
- [PATCH v6 06/21] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/09/25
- [PATCH v6 08/21] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/09/25