]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
qga: Rephrase return docs to avoid type name
authorMarkus Armbruster <armbru@redhat.com>
Thu, 17 Jul 2025 11:52:45 +0000 (13:52 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 28 Jul 2025 11:45:11 +0000 (13:45 +0200)
"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>
Message-ID: <20250717115246.3830007-4-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
qga/qapi-schema.json

index a9cc9150dc09f0edcd21f999b004c47857ab17a5..6c26ace3c980d7da75efc3a6028405243f7328e9 100644 (file)
 #     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
 ##