diff options
| author | John Snow | 2021-06-29 23:43:23 +0200 |
|---|---|---|
| committer | John Snow | 2021-07-01 03:57:08 +0200 |
| commit | 5c02c865866fdd2d17e8f5507deb4aa1f74bf59f (patch) | |
| tree | 670779e89bc04edaf36a611c7eb9633c51046cea /python/qemu/machine/machine.py | |
| parent | python: remove auto-generated pyproject.toml file (diff) | |
| download | qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.tar.gz qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.tar.xz 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/machine/machine.py')
| -rw-r--r-- | python/qemu/machine/machine.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py index e3345dfa1b..d47ab3d896 100644 --- a/python/qemu/machine/machine.py +++ b/python/qemu/machine/machine.py @@ -545,7 +545,8 @@ class QEMUMachine: @param enabled: if False, qmp monitor options will be removed from the base arguments of the resulting QEMU command line. Default is True. - @note: call this function before launch(). + + .. note:: Call this function before launch(). """ self._qmp_set = enabled |