Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-05 02:34:14 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

RST uses double-backticks

Browse source
This commit is contained in:
Richard van der Hoff 2025-08-05 18:06:26 +01:00
parent 245d3ef7b9
commit a7d0f7a999
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
meta/documentation_style.rst
View file

@ -61,9 +61,9 @@ General
horrible. horrible.
* When talking about a user's "display name", it is spelt as two words. In * 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 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 spelt as a single word, ``displayname``. (There are some historical exceptions
to this where the identifier is spelt `display_name`.) to this where the identifier is spelt ``display_name``.)
* Lists should: * Lists should:
@ -89,12 +89,12 @@ Changes between spec versions
Sections should reference the Matrix spec version they were added/changed in. This 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 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 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/changed in" tags can be documented as the following:
* `{{% added-in v="1.2" %}}` or `{{% changed-in v="1.2" %}}` within Markdown documents. * ``{{% added-in v="1.2" %}}`` or ``{{% changed-in v="1.2" %}}`` within Markdown documents.
* `x-addedInMatrixVersion` and `x-changedInMatrixVersion` within OpenAPI. * ``x-addedInMatrixVersion`` and ``x-changedInMatrixVersion`` within OpenAPI.
OpenAPI OpenAPI
~~~~~~~ ~~~~~~~
@ -190,4 +190,4 @@ Describing grammar
Use `RFC5234-style ABNF <https://datatracker.ietf.org/doc/html/rfc5234>`_ when describing Use `RFC5234-style ABNF <https://datatracker.ietf.org/doc/html/rfc5234>`_ when describing
the grammar for something in the spec, such as user IDs or server names. Use lowercase 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``).