[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 18/38] qapi/events.py: Move comments into docstrings
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v2 18/38] qapi/events.py: Move comments into docstrings |
Date: |
Mon, 28 Sep 2020 13:49:23 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
John Snow <jsnow@redhat.com> writes:
> On 9/25/20 8:19 AM, Markus Armbruster wrote:
>> What about:
>> Generate a QAPI struct variable holding the event parameters,
>> initialized with the function's arguments.
>
> Line length and style-guide limitations; docstrings need a one-liner
> summary.
They do!
> (Consistency is the hobgoblin, blah blah blah.)
>
> I am writing:
>
> """
> Generate a QAPI struct variable with an initializer.
>
> The QAPI struct describes the event parameters, and the initializer
> references the function arguments defined in `gen_event_send`.
> """
Better.
My second try:
Generate a struct variable holding the event parameters.
Initialize it with the function arguments defined in in
`gen_event_send`.
- Re: [PATCH v2 08/38] qapi/common.py: Remove python compatibility workaround, (continued)
Re: [PATCH v2 18/38] qapi/events.py: Move comments into docstrings, Cleber Rosa, 2020/09/23
[PATCH v2 13/38] qapi/common.py: add type hint annotations, John Snow, 2020/09/22
Re: [PATCH v2 13/38] qapi/common.py: add type hint annotations, Cleber Rosa, 2020/09/23
[PATCH v2 14/38] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/09/22