diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-01-20 10:53:21 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-01-26 07:04:53 +0100 |
| commit | 1defab08740e403d7cfdc84005b76744392f723d (patch) | |
| tree | 4a9df4a8ed4d61e27102362c64727afd692fa1a1 /docs/devel | |
| parent | 1110fbc35fab45b0b73eebd33a75fb792895eeb1 (diff) | |
| download | qemu-1defab08740e403d7cfdc84005b76744392f723d.zip qemu-1defab08740e403d7cfdc84005b76744392f723d.tar.gz qemu-1defab08740e403d7cfdc84005b76744392f723d.tar.bz2 | |
docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-2-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Diffstat (limited to 'docs/devel')
| -rw-r--r-- | docs/devel/qapi-code-gen.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 0c6f420..76be722 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -989,8 +989,8 @@ this:: # @feature: Description text A tagged section starts with one of the following words: -"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:". -The section ends with the start of a new section. +"Note:"/"Notes:", "Since:", "Example:"/"Examples:", "Returns:", +"TODO:". The section ends with the start of a new section. The second and subsequent lines of sections other than "Example"/"Examples" should be indented like this:: |