[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit
|
From: |
Markus Armbruster |
|
Subject: |
[PULL 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit |
|
Date: |
Tue, 9 May 2023 09:59:55 +0200 |
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>
---
docs/devel/qapi-code-gen.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index af1986f33e..289869c53b 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::
--
2.39.2
- [PULL 00/17] QAPI patches patches for 2023-05-09, Markus Armbruster, 2023/05/09
- [PULL 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments, Markus Armbruster, 2023/05/09
- [PULL 04/17] meson: Fix to make QAPI generator output depend on main.py, Markus Armbruster, 2023/05/09
- [PULL 03/17] qapi: Fix crash on stray double quote character, Markus Armbruster, 2023/05/09
- [PULL 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit,
Markus Armbruster <=
- [PULL 10/17] tests/qapi-schema/doc-good: Improve argument description tests, Markus Armbruster, 2023/05/09
- [PULL 09/17] tests/qapi-schema/doc-good: Improve a comment, Markus Armbruster, 2023/05/09
- [PULL 07/17] qapi: Tidy up a slightly awkward TODO comment, Markus Armbruster, 2023/05/09
- [PULL 08/17] qapi/dump: Indent bulleted lists consistently, Markus Armbruster, 2023/05/09
- [PULL 05/17] Revert "qapi: BlockExportRemoveMode: move comments to TODO", Markus Armbruster, 2023/05/09
- [PULL 13/17] qapi: Relax doc string @name: description indentation rules, Markus Armbruster, 2023/05/09
- [PULL 16/17] qga/qapi-schema: Reformat doc comments to conform to current conventions, Markus Armbruster, 2023/05/09
- [PULL 06/17] sphinx/qapidoc: Do not emit TODO sections into user manuals, Markus Armbruster, 2023/05/09
- [PULL 12/17] qapi: Rewrite parsing of doc comment section symbols and tags, Markus Armbruster, 2023/05/09
- [PULL 11/17] qapi: Fix argument description indentation stripping, Markus Armbruster, 2023/05/09