Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API Reference method page template - add description #36185

Merged
merged 2 commits into from
Oct 6, 2024
Merged

API Reference method page template - add description #36185

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0de662b
API Reference method page template - add description
hamishwillee Oct 4, 2024
6129d7d
Update files/en-us/mdn/writing_guidelines/page_structures/page_types/…
hamishwillee Oct 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...ting_guidelines/page_structures/page_types/api_method_subpage_template/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,11 @@ Here is an example where a method can raise a `DOMException` with a name of `Ind
- {{jsxref("TypeError")}}
- : Thrown …

## Description
hamishwillee marked this conversation as resolved.
Show resolved Hide resolved

_Detailed description of how the method behaves_
_Section omitted if an introductory paraphgraph (or two) at the top of the page are sufficient._
hamishwillee marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_Tips and quirks about the method._

I always wonder if quirks, notes, warnings, and tips should be in the intro section or the description section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description, I'd say.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I don't think we need to mention this specifically - the would clearly be part of an extended description.

## Examples

Note that we use the plural "Examples" even if the page only contains one example.
Expand Down