diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-28 12:54:13 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-05-09 08:51:27 +0200 |
| commit | 0c7811aeb9ba206a74008ca28f5b8ff8e7f74d04 (patch) | |
| tree | c78cf295094588fb15b990819ef8e6e61caadcfb | |
| parent | 792f77f376adef944f9a03e601f6ad90c2f891b2 (diff) | |
| download | qemu-0c7811aeb9ba206a74008ca28f5b8ff8e7f74d04.zip qemu-0c7811aeb9ba206a74008ca28f5b8ff8e7f74d04.tar.gz qemu-0c7811aeb9ba206a74008ca28f5b8ff8e7f74d04.tar.bz2 | |
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>
| -rw-r--r-- | docs/devel/qapi-code-gen.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index af1986f..289869c 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -989,7 +989,7 @@ The number of spaces between the ':' and the text is not significant. union branches should be described, too. 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 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 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 lines must be indented to match the first, in the same way as 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. -An 'Example' or 'Examples' section is automatically rendered -entirely as literal fixed-width text. In other sections, -the text is formatted, and rST markup can be used. +An "Example" or "Examples" section is automatically rendered entirely +as literal fixed-width text. In other sections, the text is +formatted, and rST markup can be used. For example:: |