Marc-André Lureau <marcandre.lur...@redhat.com> writes:

> The documentation parser finishes a section after an empty line. Fix the

Suggest "The documentation parser we're going to add".

> Returns: section of guest-set-vcpus, and itemize the possible return
> values.
>
> Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
> ---
>  qga/qapi-schema.json | 12 ++++--------
>  1 file changed, 4 insertions(+), 8 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 758803a..cb68c17 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -696,22 +696,18 @@
>  #
>  # Returns: The length of the initial sublist that has been successfully
>  #          processed. The guest agent maximizes this value. Possible cases:
> -#
> -#          0:                if the @vcpus list was empty on input. Guest 
> state
> +#          - 0:              if the @vcpus list was empty on input. Guest 
> state
>  #                            has not been changed. Otherwise,
> -#
> -#          Error:            processing the first node of @vcpus failed for 
> the
> +#          - Error:          processing the first node of @vcpus failed for 
> the
>  #                            reason returned. Guest state has not been 
> changed.
>  #                            Otherwise,
> -#
> -#          < length(@vcpus): more than zero initial nodes have been 
> processed,
> +#          - < length(@vcpus): more than zero initial nodes have been 
> processed,
>  #                            but not the entire @vcpus list. Guest state has
>  #                            changed accordingly. To retrieve the error
>  #                            (assuming it persists), repeat the call with the
>  #                            successfully processed initial sublist removed.
>  #                            Otherwise,
> -#
> -#          length(@vcpus):   call successful.
> +#          - length(@vcpus): call successful.
>  #
>  # Since: 1.5
>  ##

Matches how we format similar lists elswhere.

If the "empty line ends section" syntax turns out to be inconvenient, we
can try to consider indentation.  But not now.

Reply via email to