Re: [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate

2020-10-08 Thread Markus Armbruster
John Snow writes: > On 10/7/20 5:14 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> As docstrings, they'll show up in documentation and IDE help. >>> >>> The docstring style being targeted is the Sphinx documentation >>> style. Sphinx uses an extension of ReST with "domains". We use th

Re: [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate

2020-10-07 Thread John Snow
On 10/7/20 5:14 AM, Markus Armbruster wrote: John Snow writes: As docstrings, they'll show up in documentation and IDE help. The docstring style being targeted is the Sphinx documentation style. Sphinx uses an extension of ReST with "domains". We use the (implicit) Python domain, which suppor

Re: [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate

2020-10-07 Thread Markus Armbruster
John Snow writes: > As docstrings, they'll show up in documentation and IDE help. > > The docstring style being targeted is the Sphinx documentation > style. Sphinx uses an extension of ReST with "domains". We use the > (implicit) Python domain, which supports a number of custom "info > fields".

[PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate

2020-10-05 Thread John Snow
As docstrings, they'll show up in documentation and IDE help. The docstring style being targeted is the Sphinx documentation style. Sphinx uses an extension of ReST with "domains". We use the (implicit) Python domain, which supports a number of custom "info fields". Those info fields are documente