diff options
| author | John Snow <jsnow@redhat.com> | 2021-06-29 17:43:23 -0400 |
|---|---|---|
| committer | John Snow <jsnow@redhat.com> | 2021-06-30 21:57:08 -0400 |
| commit | 5c02c865866fdd2d17e8f5507deb4aa1f74bf59f (patch) | |
| tree | 670779e89bc04edaf36a611c7eb9633c51046cea /python/qemu/machine | |
| parent | 19cf0031e438374045aab8e5db0a03fb3b3070e4 (diff) | |
| download | qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.zip qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.tar.gz qemu-5c02c865866fdd2d17e8f5507deb4aa1f74bf59f.tar.bz2 | |
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')
| -rw-r--r-- | python/qemu/machine/__init__.py | 6 | ||||
| -rw-r--r-- | python/qemu/machine/machine.py | 3 |
2 files changed, 5 insertions, 4 deletions
diff --git a/python/qemu/machine/__init__.py b/python/qemu/machine/__init__.py index 728f27a..9ccd58e 100644 --- a/python/qemu/machine/__init__.py +++ b/python/qemu/machine/__init__.py @@ -4,10 +4,10 @@ QEMU development and testing library. This library provides a few high-level classes for driving QEMU from a test suite, not intended for production use. -- QEMUMachine: Configure and Boot a QEMU VM - - QEMUQtestMachine: VM class, with a qtest socket. + | QEMUQtestProtocol: send/receive qtest messages. + | QEMUMachine: Configure and Boot a QEMU VM + | +-- QEMUQtestMachine: VM class, with a qtest socket. -- QEMUQtestProtocol: Connect to, send/receive qtest messages. """ # Copyright (C) 2020-2021 John Snow for Red Hat Inc. diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py index e3345df..d47ab3d 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 |