Skip to content

WebAPI: Interface template - add the position of the description #45547

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

Open
hamishwillee wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WebAPI: Interface template - add the position of the description #45547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions ...ting_guidelines/page_structures/page_types/api_reference_page_template/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ sidebar: mdnsidebar

The summary paragraph — start by naming the interface, saying what API it is part of, and saying what it does. This should ideally be one or two short sentences. You could copy most of this from the Interface's summary on the corresponding API landing page.

> More than four or five paragraphs should be pushed into a description section before the examples.

`\{{InheritanceDiagram}}`

_To use the [domxref macro](/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#linking_to_reference_pages) in the sections below, remove the backticks and backslash in the markdown file._
Expand Down Expand Up @@ -140,6 +142,11 @@ Listen to these events using {{DOMxRef("EventTarget.addEventListener", "addEvent
Also available via the `oneventname2` property.
If the event is not experimental/deprecated/non-standard, remove the related macro calls.

## Description

> Add a more detailed detailed description of the interface if required.
> Generally if the introduction at the top of a page is likely to extend more than a rendered page of text, reduce it to a few paragraphs and push the rest to a description.

## Examples

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