John Snow adcb9b36c9 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>

2020-10-10 11:37:46 +02:00

..

__init__.py

qapi-gen: New common driver for code and doc generators

2018-03-02 13:14:09 -06:00

commands.py

qapi: Add a 'coroutine' flag for commands

2020-10-09 07:08:19 +02:00

common.py

qapi: Drop conditionals for Python 2

2020-03-05 09:24:11 +01:00

error.py

qapi: Use super() now we have Python 3

2020-03-05 09:24:11 +01:00

events.py

qapi: Add feature flags to remaining definitions

2020-03-17 19:58:34 +01:00

expr.py

qapi: Add a 'coroutine' flag for commands

2020-10-09 07:08:19 +02:00

gen.py

qapi: modify docstrings to be sphinx-compatible

2020-10-10 11:37:46 +02:00

introspect.py

qapi: Add a 'coroutine' flag for commands

2020-10-09 07:08:19 +02:00

parser.py

scripts/qapi/parser.py: improve doc comment indent handling

2020-09-29 17:55:39 +02:00

schema.py

qapi: Add a 'coroutine' flag for commands

2020-10-09 07:08:19 +02:00

source.py

qapi: Inheriting from object is pointless with Python 3, drop

2020-03-05 09:24:11 +01:00

types.py

qapi: enable use of g_autoptr with QAPI types

2020-09-03 09:38:36 +02:00

visit.py

qapi: Fix visit_type_STRUCT() not to fail for null object

2020-07-21 14:38:23 +02:00