From 5c02c865866fdd2d17e8f5507deb4aa1f74bf59f Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 29 Jun 2021 17:43:23 -0400 Subject: 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 Reviewed-by: Willian Rampazzo Reviewed-by: Wainer dos Santos Moschetta Message-id: 20210629214323.1329806-16-jsnow@redhat.com Signed-off-by: John Snow --- python/qemu/machine/machine.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'python/qemu/machine/machine.py') 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 -- cgit v1.2.3-55-g7522