Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 04:54:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Specify our usage of ABNF for grammar

Browse source
This commit is contained in:
Travis Ralston 2023-06-19 17:08:27 -06:00 committed by GitHub
parent 49957be1e3
commit c0a42fecab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
meta/documentation_style.rst
View file

@ -185,3 +185,10 @@ The subheadings which are always deemed as client-affecting are:
* Redactions * Redactions
When a new subheading is added, it must be referenced and ordered in this document. When a new subheading is added, it must be referenced and ordered in this document.
Describing grammar
~~~~~~~~~~~~~~~~~~
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
and underscore-deliminated element names (`user_id`, not `UserID` or `user-id`).