starred/qemu
1
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2026-05-21 07:37:14 +00:00
Code Issues 380 Packages Projects Releases Wiki Activity

qapi: rephrase return docs to avoid type name

Browse Source 
"Returns: <description>" is rendered like "Return: <Type> –
<description>".  Mentioning the type in the description again is
commonly redundant.  Rephrase such descriptions not to.

Well, I tried. Maybe not very hard. Sorry!

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711051045.51110-5-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
[Commit message amended to explain why]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow
2025-07-11 01:10:45 -04:00
committed by Markus Armbruster
parent 0462da9d6b
commit f7296f8de5
17 changed files with 28 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
qapi/misc.json
View File

@@ -107,7 +107,7 @@
# declared using the ``-object iothread`` command-line option. It
# is always the main thread of the process.
#
# Returns: a list of @IOThreadInfo for each iothread
# Returns: a list of info for each iothread
#
# Since: 2.0
#
@@ -511,8 +511,7 @@
#
# @option: option name
#
# Returns: list of @CommandLineOptionInfo for all options (or for the
# given @option).
# Returns: list of objects for all options (or for the given @option).
#
# Errors:
# - if the given @option doesn't exist