Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify our usage of ABNF for grammar #1582

Merged
merged 3 commits into from
Jun 28, 2023
Merged

Specify our usage of ABNF for grammar #1582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0a42fe
Specify our usage of ABNF for grammar
turt2live Jun 19, 2023
091b175
Create 1582.clarification
turt2live Jun 19, 2023
1750a87
Update meta/documentation_style.rst
turt2live Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1582.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify usage of ABNF for grammar in the documentation style guide.
7 changes: 7 additions & 0 deletions meta/documentation_style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`).