diff options
| author | John Snow <jsnow@redhat.com> | 2020-10-09 12:15:24 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2020-10-10 11:37:46 +0200 |
| commit | adcb9b36c9b0a63e3b0cf81994430cfb0d720571 (patch) | |
| tree | 0489b8cea9f6ec7766c74258839a1c0bdf2eb37b /scripts/tracetool/backend | |
| parent | 1ec43ca42e153414f586aeda45f37acffbfd1ca1 (diff) | |
| download | focaccia-qemu-adcb9b36c9b0a63e3b0cf81994430cfb0d720571.tar.gz focaccia-qemu-adcb9b36c9b0a63e3b0cf81994430cfb0d720571.zip | |
qapi: modify docstrings to be sphinx-compatible
A precise style guide and a package-wide overhaul is forthcoming pending further discussion and consensus. For now, merely avoid obvious errors that cause Sphinx documentation build problems, using a style loosely based on PEP 257 and Sphinx Autodoc. It is chosen for interoperability with our existing Sphinx framework, and because it has loose recognition in the Pycharm IDE. See also: https://www.python.org/dev/peps/pep-0257/ https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists Signed-off-by: John Snow <jsnow@redhat.com> Message-Id: <20201009161558.107041-3-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/tracetool/backend')
0 files changed, 0 insertions, 0 deletions