Add guidance about how to describe the value of a property

wbamberg · May 2, 2024 · ebc9d0a · ebc9d0a
1 parent 37aa127
commit ebc9d0a
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/...ng_guidelines/page_structures/page_types/api_property_subpage_template/index.md b/...ng_guidelines/page_structures/page_types/api_property_subpage_template/index.md
@@ -88,7 +88,11 @@ You could copy most of this from the property's summary on the corresponding API
 
 ## Value
 
-Include a description of the property's value, including data type and what it represents.
+Include a description of the property's value, including data type and what it represents. This should be in the form: "A [name of the property type] representing ...". For example:
+
+> A string representing...
+
+Note that some property pages are written in the form "Returns a [name of the property type] representing..." but this is not the recommended form.
 
 ## Examples