Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-28 03:48:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update documentation_style.rst (#3352)

Browse source
This commit is contained in:
Richard van der Hoff 2021-08-19 18:38:02 +01:00 committed by Richard van der Hoff
parent a187996383
commit cafb9ff5a8
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
meta/documentation_style.rst
View file

@ -66,6 +66,12 @@ Lists should:
* Be used where they provide clarity.
* Contain entries which start with a capital and end with a full stop.
When talking about properties in JSON objects, prefer the word "property" to "field",
"member", or various other alternatives. For example: "this property will be set to
X if ...". Also avoid the term "key" unless you are specifically talking about the
*name* of a property - and be mindful of the scope for confusion with cryptographic
keys.
OpenAPI
~~~~~~~