From c0a42fecabc7cb35173517fb182bbf4b03cb4799 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 19 Jun 2023 17:08:27 -0600 Subject: [PATCH] Specify our usage of ABNF for grammar --- meta/documentation_style.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/meta/documentation_style.rst b/meta/documentation_style.rst index 468b2675..0a8da229 100644 --- a/meta/documentation_style.rst +++ b/meta/documentation_style.rst @@ -185,3 +185,10 @@ The subheadings which are always deemed as client-affecting are: * Redactions 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`).