summary refs log tree commit diff stats
path: root/python/qemu/utils
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-06-29 17:43:23 -0400
committerJohn Snow <jsnow@redhat.com>2021-06-30 21:57:08 -0400
commit5c02c865866fdd2d17e8f5507deb4aa1f74bf59f (patch)
tree670779e89bc04edaf36a611c7eb9633c51046cea /python/qemu/utils
parent19cf0031e438374045aab8e5db0a03fb3b3070e4 (diff)
downloadfocaccia-qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.tar.gz
focaccia-qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.zip
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>
Diffstat (limited to 'python/qemu/utils')
-rw-r--r--python/qemu/utils/accel.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/python/qemu/utils/accel.py b/python/qemu/utils/accel.py
index 297933df2a..386ff640ca 100644
--- a/python/qemu/utils/accel.py
+++ b/python/qemu/utils/accel.py
@@ -36,7 +36,7 @@ def list_accel(qemu_bin: str) -> List[str]:
     List accelerators enabled in the QEMU binary.
 
     @param qemu_bin (str): path to the QEMU binary.
-    @raise Exception: if failed to run `qemu -accel help`
+    @raise Exception: if failed to run ``qemu -accel help``
     @return a list of accelerator names.
     """
     if not qemu_bin: