python: Fix broken ReST docstrings

This patch *doesn't* update all of the docstring standards across the
QEMU package directory to make our docstring usage consistent. It
*doesn't* fix the formatting to make it look pretty or reasonable in
generated output. It *does* fix a few small instances where Sphinx would
emit a build warning because of malformed ReST -- If we built our Python
docs with Sphinx.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Willian Rampazzo <willianr@redhat.com>
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
Message-id: 20210629214323.1329806-16-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
This commit is contained in:
John Snow
2021-06-30 21:57:08 -04:00
parent 19cf0031e4
commit 5c02c86586
5 changed files with 8 additions and 6 deletions
+1
View File
@@ -279,6 +279,7 @@ class QEMUMonitorProtocol:
None). The value passed will set the behavior of the
underneath QMP socket as described in [1].
Default value is set to 15.0.
@return QMP greeting dict
@raise OSError on socket connection errors
@raise QMPConnectError if the greeting is not received
+1 -1
View File
@@ -156,7 +156,7 @@ class QOMCommand:
"""
Run a fully-parsed subcommand, with error-handling for the CLI.
:return: The return code from `.run()`.
:return: The return code from `run()`.
"""
try:
cmd = cls(args)