From 0de662b59425816bcfa56f0b82f8876320cd6484 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Fri, 4 Oct 2024 14:07:19 +1000 Subject: [PATCH 1/2] API Reference method page template - add description --- .../page_types/api_method_subpage_template/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md index 92fb85ac635d47c..2e082f51b698bfe 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md @@ -129,6 +129,11 @@ Here is an example where a method can raise a `DOMException` with a name of `Ind - {{jsxref("TypeError")}} - : Thrown … +## Description + +_Detailed description of how the method behaves_ +_Section omitted if an introductory paraphgraph (or two) at the top of the page are sufficient._ + ## Examples Note that we use the plural "Examples" even if the page only contains one example. From 6129d7d4b12499555b9eada0f3956f562c58ec63 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Mon, 7 Oct 2024 07:48:44 +1100 Subject: [PATCH 2/2] Update files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md Co-authored-by: Onkar Khadangale <87750369+OnkarRuikar@users.noreply.github.com> --- .../page_types/api_method_subpage_template/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md index 2e082f51b698bfe..4b6d59de9410825 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_method_subpage_template/index.md @@ -132,7 +132,7 @@ Here is an example where a method can raise a `DOMException` with a name of `Ind ## Description _Detailed description of how the method behaves_ -_Section omitted if an introductory paraphgraph (or two) at the top of the page are sufficient._ +_Section omitted if an introductory paragraph (or two) at the top of the page is sufficient._ ## Examples