[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent handling |
Date: |
Tue, 29 Sep 2020 15:03:40 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
Peter Maydell <peter.maydell@linaro.org> writes:
> On Mon, 28 Sep 2020 at 20:16, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>> > +Descriptions of arguments can span multiple lines. The description
>> > +text can start on the line following the '@argname:', in which case
>> > +it must not be indented at all. It can also start on the same line
>> > +as the '@argname:'. In this case if it spans multiple lines then
>> > +second and subsequent lines must be indented to line up with the
>> > +first character of the first line of the description:
>>
>> Please put two spaces after sentence-ending punctuation, for local
>> consistency, and to keep Emacs sentence commands working.
>
> Is there a python lint program that can auto-check this?
> Otherwise I am going to continue to put single-spaces at
> least some of the time, because that's the way I write all
> the other English text I write...
John, any idea? The ones I use apparently don't, even though PEP 8 asks
for this style.
>> Can touch this up in my tree, of course.
>
> That would certainly be easier for me :-)
Happy to help :)
- [PATCH v6 09/21] docs/interop: Convert qemu-qmp-ref to rST, (continued)
[PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/09/25
[PATCH v6 07/21] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/09/25
[PATCH v6 11/21] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/09/25
[PATCH v6 15/21] tests/qapi-schema: Add test of the rST QAPI doc-comment outputn, Peter Maydell, 2020/09/25
[PATCH v6 14/21] meson.build: Make manuals depend on source to Sphinx extensions, Peter Maydell, 2020/09/25