On Thu, Jul 17, 2025 at 7:52 AM Markus Armbruster <armbru@redhat.com> wrote:
>
> "Returns: <description>" is rendered like
>
> Return: <Type> – <description>
>
> Mentioning the type in the description again is commonly redundant.
> There is just one such description. Rephrase it not to mention the
> type.
>
> We did this for qapi/ in commit f7296f8de5c (qapi: rephrase return
> docs to avoid type name).
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
> ---
> qga/qapi-schema.json | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index a9cc9150dc..6c26ace3c9 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -534,8 +534,7 @@
> # discarded. The default value is zero, meaning "discard every
> # free block".
> #
> -# Returns: A @GuestFilesystemTrimResponse which contains the status of
> -# all trimmed paths. (since 2.4)
> +# Returns: status of all trimmed paths. (since 2.4)
> #
> # Since: 1.2
> ##
> --
> 2.49.0
>