Skip to content

Commit 8b2c126

Browse files
authored
Update documentation_style.rst (#3352)
1 parent dd6a55a commit 8b2c126

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

meta/documentation_style.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ Lists should:
6666
* Be used where they provide clarity.
6767
* Contain entries which start with a capital and end with a full stop.
6868

69+
When talking about properties in JSON objects, prefer the word "property" to "field",
70+
"member", or various other alternatives. For example: "this property will be set to
71+
X if ...". Also avoid the term "key" unless you are specifically talking about the
72+
*name* of a property - and be mindful of the scope for confusion with cryptographic
73+
keys.
74+
6975
OpenAPI
7076
~~~~~~~
7177

0 commit comments

Comments
 (0)