qemu-devel
[Top][All Lists]
Advanced

[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: Peter Maydell
Subject: Re: [PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent handling
Date: Tue, 29 Sep 2020 09:55:45 +0100

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

> Can touch this up in my tree, of course.

That would certainly be easier for me :-)

thanks
-- PMM



reply via email to

[Prev in Thread] Current Thread [Next in Thread]