mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-11 03:24:58 -06:00
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:
parent
19cf0031e4
commit
5c02c86586
5 changed files with 8 additions and 6 deletions
|
@ -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:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue