@@ -763,8 +763,8 @@ Names beginning with ``x-`` used to signify "experimental". This
763
763
convention has been replaced by special feature "unstable".
764
764
765
765
Pragmas ``command-name-exceptions `` and ``member-name-exceptions `` let
766
- you violate naming rules. Use for new code is strongly discouraged. See
767
- `Pragma directives `_ for details.
766
+ you violate naming rules. Use for new code is strongly discouraged.
767
+ See `Pragma directives `_ for details.
768
768
769
769
770
770
Downstream extensions
@@ -1013,7 +1013,7 @@ like this::
1013
1013
document the success and the error response, respectively.
1014
1014
1015
1015
"Errors" sections should be formatted as an rST list, each entry
1016
- detailing a relevant error condition. For example::
1016
+ detailing a relevant error condition. For example::
1017
1017
1018
1018
# Errors:
1019
1019
# - If @device does not exist, DeviceNotFound
@@ -1026,13 +1026,13 @@ definition.
1026
1026
QMP). In other sections, the text is formatted, and rST markup can be
1027
1027
used.
1028
1028
1029
- QMP Examples can be added by using the ``.. qmp-example:: ``
1030
- directive. In its simplest form, this can be used to contain a single
1031
- QMP code block which accepts standard JSON syntax with additional server
1029
+ QMP Examples can be added by using the ``.. qmp-example:: `` directive.
1030
+ In its simplest form, this can be used to contain a single QMP code
1031
+ block which accepts standard JSON syntax with additional server
1032
1032
directionality indicators (``-> `` and ``<- ``), and elisions (``... ``).
1033
1033
1034
1034
Optionally, a plaintext title may be provided by using the ``:title: ``
1035
- directive option. If the title is omitted, the example title will
1035
+ directive option. If the title is omitted, the example title will
1036
1036
default to "Example:".
1037
1037
1038
1038
A simple QMP example::
@@ -1043,10 +1043,10 @@ A simple QMP example::
1043
1043
# -> { "execute": "query-block" }
1044
1044
# <- { ... }
1045
1045
1046
- More complex or multi-step examples where exposition is needed before or
1047
- between QMP code blocks can be created by using the ``:annotated: ``
1048
- directive option. When using this option, nested QMP code blocks must be
1049
- entered explicitly with rST's ``:: `` syntax.
1046
+ More complex or multi-step examples where exposition is needed before
1047
+ or between QMP code blocks can be created by using the ``:annotated: ``
1048
+ directive option. When using this option, nested QMP code blocks must
1049
+ be entered explicitly with rST's ``:: `` syntax.
1050
1050
1051
1051
Highlighting in non-QMP languages can be accomplished by using the
1052
1052
``.. code-block:: lang `` directive, and non-highlighted text can be
@@ -1466,7 +1466,9 @@ As an example, we'll use the following schema, which describes a
1466
1466
single complex user-defined type, along with command which takes a
1467
1467
list of that type as a parameter, and returns a single element of that
1468
1468
type. The user is responsible for writing the implementation of
1469
- qmp_my_command(); everything else is produced by the generator. ::
1469
+ qmp_my_command(); everything else is produced by the generator.
1470
+
1471
+ ::
1470
1472
1471
1473
$ cat example-schema.json
1472
1474
{ 'struct': 'UserDefOne',
0 commit comments