ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/devel/qapi-code-gen: Clean up use of quotes a bit 

Section "Definition documentation" uses both single and double quotes
around doc text snippets.  Stick to double quotes.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-2-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
This commit is contained in:
Markus Armbruster 2023-04-28 12:54:13 +02:00
parent 792f77f376
commit 0c7811aeb9
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/devel/qapi-code-gen.rst
View File

@ -989,7 +989,7 @@ The number of spaces between the ':' and the text is not significant.
union branches should be described, too. union branches should be described, too.
Extensions added after the definition was first released carry a Extensions added after the definition was first released carry a
'(since x.y.z)' comment. "(since x.y.z)" comment.
The feature descriptions must be preceded by a line "Features:", like The feature descriptions must be preceded by a line "Features:", like
this:: this::
@ -1003,17 +1003,17 @@ The section ends with the start of a new section.
The text of a section can start on a new line, in The text of a section can start on a new line, in
which case it must not be indented at all. It can also start which case it must not be indented at all. It can also start
on the same line as the 'Note:', 'Returns:', etc tag. In this on the same line as the "Note:", "Returns:", etc tag. In this
case if it spans multiple lines then second and subsequent case if it spans multiple lines then second and subsequent
lines must be indented to match the first, in the same way as lines must be indented to match the first, in the same way as
multiline argument descriptions. multiline argument descriptions.
A 'Since: x.y.z' tagged section lists the release that introduced the A "Since: x.y.z" tagged section lists the release that introduced the
definition. definition.
An 'Example' or 'Examples' section is automatically rendered An "Example" or "Examples" section is automatically rendered entirely
entirely as literal fixed-width text. In other sections, as literal fixed-width text. In other sections, the text is
the text is formatted, and rST markup can be used. formatted, and rST markup can be used.
For example:: For example::