[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 05/47] qapi/doc.py: Change code templates from function to
|
From: |
Markus Armbruster |
|
Subject: |
Re: [PATCH v3 05/47] qapi/doc.py: Change code templates from function to string |
|
Date: |
Fri, 25 Sep 2020 10:59:15 +0200 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
John Snow <jsnow@redhat.com> writes:
> For whatever reason, when these are stored as functions instead of
> strings, it confuses sphinx-autodoc into believing them to be
> docstrings, and it chokes on the syntax.
>
> Keeping them as dumb strings instead avoids the problem.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
Quoting my review of the patch that added it: "This .format business is
perhaps a bit too clever. But let's move on."
doc.py is about to be replaced, obsoleting this patch. Regardless:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
- [PATCH v3 12/47] qapi: enforce import order/styling with isort, (continued)
Re: [PATCH v3 12/47] qapi: enforce import order/styling with isort, Cleber Rosa, 2020/09/29
[PATCH v3 10/47] qapi: Prefer explicit relative imports, John Snow, 2020/09/24
[PATCH v3 13/47] qapi: delint using flake8, John Snow, 2020/09/24
[PATCH v3 05/47] qapi/doc.py: Change code templates from function to string, John Snow, 2020/09/24
[PATCH v3 15/47] qapi/common.py: Remove python compatibility workaround, John Snow, 2020/09/24
[PATCH v3 20/47] qapi/common.py: add type hint annotations, John Snow, 2020/09/24
[PATCH v3 17/47] qapi/common.py: delint with pylint, John Snow, 2020/09/24
[PATCH v3 14/47] qapi: add pylintrc, John Snow, 2020/09/24
[PATCH v3 24/47] qapi/events.py: add type hint annotations, John Snow, 2020/09/24
[PATCH v3 19/47] qapi/common.py: check with pylint, John Snow, 2020/09/24
[PATCH v3 23/47] qapi: establish mypy type-checking baseline, John Snow, 2020/09/24