[PATCH 1/3] docs: fix errors formatting in test-good

John Snow posted 3 patches 5 months, 3 weeks ago
There is a newer version of this series
[PATCH 1/3] docs: fix errors formatting in test-good
Posted by John Snow 5 months, 3 weeks ago
If we remove the legacy parser, this formulation begins to fail because
the body text is appended directly after the field list entry, which is
invalid rST syntax.

Markus: suggest where the new Exception(s) should go, if anywhere, and
how to update the tests? I'm assuming deeply you'll want to.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 tests/qapi-schema/doc-good.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index 14b808f9090..6dcde8fd7e8 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -165,7 +165,8 @@
 #
 # Returns: @Object
 #
-# Errors: some
+# Errors:
+#     - some
 #
 # TODO: frobnicate
 #
-- 
2.48.1
Re: [PATCH 1/3] docs: fix errors formatting in test-good
Posted by Markus Armbruster 5 months, 3 weeks ago
John Snow <jsnow@redhat.com> writes:

> If we remove the legacy parser, this formulation begins to fail because
> the body text is appended directly after the field list entry, which is
> invalid rST syntax.
>
> Markus: suggest where the new Exception(s) should go, if anywhere, and
> how to update the tests? I'm assuming deeply you'll want to.

I'm confused and out of time for the week.  Can you give me a bit more
context?

> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  tests/qapi-schema/doc-good.json | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
> index 14b808f9090..6dcde8fd7e8 100644
> --- a/tests/qapi-schema/doc-good.json
> +++ b/tests/qapi-schema/doc-good.json
> @@ -165,7 +165,8 @@
>  #
>  # Returns: @Object
>  #
> -# Errors: some
> +# Errors:
> +#     - some
>  #
>  # TODO: frobnicate
>  #