From 8b2c12626094d16457b35b5af4a5ed6e1ac5b4c2 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Thu, 19 Aug 2021 18:38:02 +0100 Subject: [PATCH] Update documentation_style.rst (#3352) --- meta/documentation_style.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/meta/documentation_style.rst b/meta/documentation_style.rst index 6779c78c..aea495bd 100644 --- a/meta/documentation_style.rst +++ b/meta/documentation_style.rst @@ -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 ~~~~~~~