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

Property pages need no syntax section #8349

Merged
merged 1 commit into from
Aug 26, 2021
Merged

Property pages need no syntax section #8349

Show file tree
Hide file tree
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
8 changes: 2 additions & 6 deletions files/en-us/mdn/structures/page_types/api_property_subpage_template/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ browser-compat: path.to.feature.NameOfTheProperty
>
> The frontmatter at the top of the page is used to define "page metadata".
> The values should be updated appropriately for the particular property.
>
>
> ```
> ---
> title: NameOfTheParentInterface.NameOfTheProperty
Expand Down Expand Up @@ -85,10 +85,6 @@ The summary paragraph — start by naming the property, saying what interface it
This should ideally be 1 or 2 short sentences.
You could copy most of this from the property's summary on the corresponding API reference page. Include whether it is read-only or not.

## Syntax

Fill in a syntax box, according to the guidance in our [syntax sections](/en-US/docs/MDN/Structures/Syntax_sections) article.

### Value

Include a description of the property's value, including data type and what it represents.
Expand Down Expand Up @@ -119,4 +115,4 @@ And/or include a list of links to useful code samples that live elsewhere:

- Include list of
- other links related to
- this API that might be useful
- this API that might be useful
13 changes: 1 addition & 12 deletions files/en-us/mdn/structures/syntax_sections/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,20 +170,9 @@ <h4>Note</h4>

<h3 id="Properties">Properties</h3>

<h4 id="Syntax_block_2">Syntax block</h4>

<p>Start with a syntax block, like this (see {{DOMxRef("IntersectionObserver.root")}}):</p>

<pre class="brush: js">var root = observer.root;</pre>

<p>For a non-read-only property, it is a good idea to include two lines, which show getting and setting the property (see {{DOMxRef("AudioParam.value")}}):</p>

<pre class="brush: js">gain = gainNode.gain.value;
gainNode.gain.value = 0;</pre>

<h4 id="Value_section">Value section</h4>

<p>Below the syntax block you need to include a "Value" subsection, which contains a explanation of the property's value — both its data type and what its purpose is.</p>
<p>Properties contain no syntax section. Instead, add a "Value" section containing an explanation of the property's value. Describe its data type and what its purpose is.</p>

<h4 id="Exceptions_section_2">Exceptions section</h4>

Expand Down