Re: [PATCH 03/11] docs/qapi-code-gen: add "TODO" subsection

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> Split the "TODO" section description into its own little section, and
> add a dedicated example for it.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  docs/devel/qapi-code-gen.rst | 14 ++++++++++++--
>  1 file changed, 12 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
> index 0f66f012be1..977ed1aa3bd 100644
> --- a/docs/devel/qapi-code-gen.rst
> +++ b/docs/devel/qapi-code-gen.rst
> @@ -1037,8 +1037,7 @@ detailing a relevant error condition.  For example::
>  A "Since: x.y" tagged section lists the release that introduced the
>  definition.
>  
> -"TODO" sections are not rendered (they are for developers, not users of
> -QMP).  In other sections, the text is formatted, and rST markup can be
> +In other sections, the text is formatted, and rST markup can be
>  used.
>  
>  QMP Examples can be added by using the ``.. qmp-example::`` directive.
> @@ -1089,6 +1088,17 @@ Highlighting in non-QMP languages can be accomplished by using the
>  achieved by omitting the language argument.
>  
>  
> +TODO
> +^^^^
> +
> +"TODO" tagged sections are not rendered (they are for developers, not users of

Wrap lines at colum 70, please.

> +QMP). They can appear anywhere after the introductory section::

Two spaces between sentences for consistency, please.

> +
> +  #
> +  ## TODO: This is not rendered in the documentation.

Why the second '#'?

> +  #
> +
> +
>  Putting it all together
>  ^^^^^^^^^^^^^^^^^^^^^^^