Update documentation_style.rst (#3352)

daenney/msc-server-status
Richard van der Hoff 3 years ago committed by GitHub
parent dd6a55a848
commit 8b2c126260
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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
~~~~~~~

Loading…
Cancel
Save