From a7d0f7a999668bd4204292a04a2ecf494c34a089 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 5 Aug 2025 18:06:26 +0100 Subject: [PATCH] RST uses double-backticks --- meta/documentation_style.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/meta/documentation_style.rst b/meta/documentation_style.rst index 36c8d6c2..afb5ff98 100644 --- a/meta/documentation_style.rst +++ b/meta/documentation_style.rst @@ -61,9 +61,9 @@ General horrible. * When talking about a user's "display name", it is spelt as two words. In - identifiers such as within the content of an `m.room.member` event, it is - spelt as a single word, `displayname`. (There are some historical exceptions - to this where the identifier is spelt `display_name`.) + identifiers such as within the content of an ``m.room.member`` event, it is + spelt as a single word, ``displayname``. (There are some historical exceptions + to this where the identifier is spelt ``display_name``.) * Lists should: @@ -89,12 +89,12 @@ Changes between spec versions Sections should reference the Matrix spec version they were added/changed in. This is often a guess at what the next version will be - please use the currently released version with a minor version bump as the referenced version. For example, if the -current version is `v1.1` then annotate your changes with `v1.2`. +current version is ``v1.1`` then annotate your changes with ``v1.2``. "Added/changed in" tags can be documented as the following: -* `{{% added-in v="1.2" %}}` or `{{% changed-in v="1.2" %}}` within Markdown documents. -* `x-addedInMatrixVersion` and `x-changedInMatrixVersion` within OpenAPI. +* ``{{% added-in v="1.2" %}}`` or ``{{% changed-in v="1.2" %}}`` within Markdown documents. +* ``x-addedInMatrixVersion`` and ``x-changedInMatrixVersion`` within OpenAPI. OpenAPI ~~~~~~~ @@ -190,4 +190,4 @@ Describing grammar Use `RFC5234-style ABNF `_ when describing the grammar for something in the spec, such as user IDs or server names. Use lowercase -and underscore-delimited element names (`user_id`, not `UserID` or `user-id`). +and underscore-delimited element names (``user_id``, not ``UserID`` or ``user-id``).