qemu-devel
[Top][All Lists]
Advanced

[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: John Snow
Subject: Re: [PATCH v2 18/38] qapi/events.py: Move comments into docstrings
Date: Fri, 25 Sep 2020 11:55:31 -0400
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0

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.

(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`.
    """




reply via email to

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