From ebc9d0af3525a48f629ac8d487582c9c3957cd95 Mon Sep 17 00:00:00 2001 From: wbamberg Date: Wed, 1 May 2024 19:48:55 -0700 Subject: [PATCH] Add guidance about how to describe the value of a property --- .../page_types/api_property_subpage_template/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md index 9b3e409c0ccf54b..b902567cb57dece 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_property_subpage_template/index.md +++ b/files/en-us/mdn/writing_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