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.

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

Add prose and meta-docs for [LegacyNullToEmptyString] #28213

Merged
merged 20 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d298448
Add standard sentence to properties with [LegacyNullToEmptyString]]
teoli2003 Jul 27, 2023
1029ffd
Add standard sentence to attributes with [LegacyNullToEmptyString]]
teoli2003 Jul 27, 2023
e20793d
Add meta-info about [LegacyNullToEmptyString]]
teoli2003 Jul 27, 2023
70f7864
Fix prose
teoli2003 Jul 27, 2023
ae1032f
Update files/en-us/mdn/writing_guidelines/howto/write_an_api_referenc…
teoli2003 Jan 10, 2024
5117429
Update files/en-us/web/api/canvasrenderingcontext2d/createpattern/ind…
teoli2003 Jan 10, 2024
a863e62
Update files/en-us/web/api/window/open/index.md
teoli2003 Jan 10, 2024
5240c82
Update files/en-us/web/api/window/open/index.md
teoli2003 Jan 10, 2024
1f4c3a2
Update files/en-us/web/api/element/innerhtml/index.md
teoli2003 Jan 10, 2024
86e7ef8
Update files/en-us/web/api/domimplementation/createdocument/index.md
teoli2003 Jan 10, 2024
06ae4bc
Update files/en-us/web/api/window/open/index.md
teoli2003 Jan 10, 2024
43545f3
Update files/en-us/web/api/cssstyledeclaration/setproperty/index.md
teoli2003 Jan 10, 2024
643dc5f
Update files/en-us/web/api/window/open/index.md
teoli2003 Jan 10, 2024
c8bb3fa
Add link in template
teoli2003 Jan 10, 2024
15bd5a3
Update files/en-us/mdn/writing_guidelines/howto/write_an_api_referenc…
teoli2003 Jan 10, 2024
33a322b
Update text
teoli2003 Jan 10, 2024
241dbac
Update files/en-us/web/api/window/open/index.md
teoli2003 May 2, 2024
24839e6
Apply suggestions from code review
estelle Jul 10, 2024
b0e2eb4
Merge branch 'main' into LegacyNullToEmptyString
estelle Jul 10, 2024
b68f8e5
Apply suggestions from code review
Josh-Cena Jul 12, 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
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,18 @@ readonly attribute MediaError? error;

The property value is an object of type `MediaError`. The question mark (`'?'`) indicates that it can take a value of `null`, and the documentation must explain _when_ this may occur. If no question mark is present, the `error` property can't be `null`.

The type of the property may be prefixed with an _extended attribute_, a string enclosed in square brackets (like `[LegacyNullToEmptyString]`). Such extended attributes indicate special behaviors that must be described in the prose. Here is a list of standard extended attributes of types, and the addition that must be made:

- `[LegacyNullToEmptyString]`

- : The `null` value is converted to a string in a non-standard way. The standard way is to convert it to the `"null"` string, but in this case, it is converted to `""`.

Add the following sentence to the end of the _Value_ section of the article:

_When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.innerHTML = null` is equivalent to `elt.innerHTML = ""`._

The small inline example has to be adapted for each property.

### Writing permissions on the property

```webidl
Expand Down Expand Up @@ -348,6 +360,11 @@ TextTrack addTextTrack(TextTrackKind kind,

The parameters of a method are listed in the Syntax section of the method sub-page. They are listed in the WebIDL in order, between the parenthesis, as a comma-separated list. Each parameter has a name (indicated above) and a type (e.g. a `'?'` means that the `null` value is valid.) If marked `optional`, the parameter is optional to include in a method call and must have the \\{{OptionalInline}} flag included when it is listed in the Syntax section. The parameter's default value is listed after the equality sign (`'='`).

Parameter types may have special behaviors described using extended attributes (like `[LegacyNullToEmptyString]`). Here is the list of such attributes, and the addition you have to do in the prose:

- `[LegacyNullToEmptyString]`
- : Add the following sentence at the end of the parameter description: _A ["null"](/en-US/docs/Web/JavaScript/Reference/Operators/null) value is treated the same as the empty string (`""`)._
estelle marked this conversation as resolved.
Show resolved Hide resolved

### Type of the return value

```webidl
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ 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. Note that some WebIDL extended attributes with specific meanings can be associated with the type. There are standard ways to document them, consult [Ìnformation contained in a WebIDL file](/en-US/docs/MDN/Writing_guidelines/Howto/Write_an_API_reference/Information_contained_in_a_WebIDL_file#type_of_the_property) for more information.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ createPattern(image, repetition)
- `"repeat-y"` (vertical only)
- `"no-repeat"` (neither direction)

If `repetition` is specified as an empty string (`""`) or [`null`](/en-US/docs/Web/JavaScript/Reference/Operators/null) (but not {{jsxref("undefined")}}), a value of `"repeat"` will be used.
A [`null`](/en-US/docs/Web/JavaScript/Reference/Operators/null) value is treated the same as the empty string (`""`): both are synonyms of `"repeat"`.

### Return value

Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/characterdata/data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ The **`data`** property of the {{domxref("CharacterData")}} interface represent

A string with the character information contained in the {{domxref("CharacterData")}} node.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `cd.data = null` is equivalent to `cd.data = ""`.

## Example

> **Note:** {{domxref("CharacterData")}} is an abstract interface.
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/cssstyledeclaration/cssfloat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ When setting, it invokes {{DOMxRef("CSSStyleDeclaration.setProperty()")}} with `

A string.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `csd.cssFloat = null` is equivalent to `csd.cssFloat = ""`.

## Example

In the below example, the stylesheet contains a single rule for `.box`, which has the {{cssxref("float")}} property with a value of `left`. This value will be returned by `cssFloat`. We then set the value to "right" using `cssFloat`, and return the new value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ setProperty(propertyName, value, priority)
- : A string representing the CSS property name (hyphen case) to be modified.
- `value` {{optional_inline}}
- : A string containing the new property value. If not specified, treated
as the empty string.
as the empty string. A ["null"](/en-US/docs/Web/JavaScript/Reference/Operators/null) value is treated the same as the empty string (`""`).
estelle marked this conversation as resolved.
Show resolved Hide resolved
> **Note:** `value` must not contain `"!important"`, that should be set using the `priority` parameter.
- `priority` {{optional_inline}}

Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/document/alinkcolor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ during the time between `mousedown` and `mouseup` events.

A string containing the name of the color (e.g., `blue`, `darkblue`, etc.) or the hexadecimal value of the color (e.g., `#0000FF`).

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `document.alinkColor = null` is equivalent to `document.alinkColor = ""`.

## Notes

The default value for this property in Mozilla Firefox is red (`#ee0000` in
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/document/bgcolor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ current document.

A string representing the color as a word (e.g., "red") or hexadecimal value (e.g., "`#ff0000`").

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `document.bgColor = null` is equivalent to `document.bgColor = ""`.

## Examples

```js
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/document/linkcolor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ This property is deprecated. As an alternative, you can set the CSS

A string representing the color as a word (e.g., `red`) or hexadecimal value (e.g., `#ff0000`).

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `document.linkColor = null` is equivalent to `document.linkColor = ""`.

## Examples

```js
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/document/vlinkcolor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ links that the user has visited in the document.

A string representing the color as a word (e.g., `"red"`) or hexadecimal value (e.g., `"#ff0000"`).

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `document.vlinkColor = null` is equivalent to `document.vlinkColor = ""`.

## Notes

- The default value for this property in Mozilla Firefox is purple
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ returns an {{domxref("XMLDocument")}}.
## Syntax

```js-nolint
createDocument(namespaceURI, qualifiedNameStr)
createDocument(namespaceURI, qualifiedNameStr, documentType)
createDocument(namespaceURI, qualifiedName)
createDocument(namespaceURI, qualifiedName, documentType)
```

### Parameters

- `namespaceURI`
- : A string containing the namespace URI of the document to be
created, or `null` if the document doesn't belong to one.
- `qualifiedNameStr`
- `qualifiedName`
- : A string containing the qualified name, that is an optional
prefix and colon plus the local root element name, of the document to be created.
prefix and colon plus the local root element name, of the document to be created. A ["null"](/en-US/docs/Web/JavaScript/Reference/Operators/null) value is treated the same as the empty string (`""`).
estelle marked this conversation as resolved.
Show resolved Hide resolved
- `documentType` {{optional_inline}}
- : Is the {{domxref("DocumentType")}} of the document to be created. It defaults to
`null`.
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/element/innerhtml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ descendants. Setting the value of `innerHTML` removes all of the element's
descendants and replaces them with nodes constructed by parsing the HTML given in the
string _htmlString_.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.innerHTML = null` is equivalent to `elt.innerHTML = ""`.

### Exceptions

- `SyntaxError` {{domxref("DOMException")}}
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/element/outerhtml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Setting the value of `outerHTML` replaces the element and all of its
descendants with a new DOM tree constructed by parsing the specified
`htmlString`.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.outerHTML = null` is equivalent to `elt.innerHTML = ""`.
Josh-Cena marked this conversation as resolved.
Show resolved Hide resolved

### Exceptions

- `SyntaxError` {{domxref("DOMException")}}
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/htmlfontelement/color/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ The format of the string must follow one of the following HTML microsyntaxes:

A string.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.color = null` is equivalent to `elt.color = ""`.

## Examples

```js
Expand Down
4 changes: 3 additions & 1 deletion files/en-us/web/api/htmlimageelement/border/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ For compatibility (or perhaps other) reasons, you can use the older properties i
A string containing an integer value specifying the thickness of the
border that should surround the image, in CSS pixels. A value of `0`, or an
empty string, indicates that there should be no border drawn. The default value of
`border` is `0`
`border` is `0`.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.border = null` is equivalent to `elt.border = ""`.

## Usage notes

Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/htmltableelement/bgcolor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ background color of the table.

A string representing a color value.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.bgColor = null` is equivalent to `elt.bgColor = ""`.

## Examples

```js
Expand Down
4 changes: 3 additions & 1 deletion files/en-us/web/api/htmltableelement/cellpadding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ padding around the individual cells of the table.

## Value

A string representing pixels (e.g. "10") or a percentage value (e.g. "10%").
A string representing pixels (e.g., `"10"`) or a percentage value (e.g., `"10%"`).

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.cellPadding = null` is equivalent to `elt.cellPadding = ""`.

## Examples

Expand Down
5 changes: 3 additions & 2 deletions files/en-us/web/api/htmltableelement/cellspacing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ representing a table's cells. Any two cells are separated by the sum of the

## Value

A string which is either a number of pixels (such as
`"10"`) or a percentage value (like `"10%"`).
A string which is either a number of pixels (such as `"10"`) or a percentage value (like `"10%"`).

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `elt.cellSpacing = null` is equivalent to `elt.cellSpacing = ""`.

## Examples

Expand Down
5 changes: 1 addition & 4 deletions files/en-us/web/api/medialist/mediatext/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,7 @@ different queries separated by commas, e.g. `screen, print`. Note that the
`mediaText` will immediately update the behavior of the
document.

Also note that is you try to set
`mediaText` to `null`, it will be treated as an empty
string, i.e. the value will be set to
`""`.
When set to the `null` value, that `null` value is converted to the empty string (`""`), so `ml.mediaText = null` is equivalent to `ml.mediaText = ""`.

## Examples

Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/shadowroot/innerhtml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ interface sets or returns a reference to the DOM tree inside the

A string.

When set to the `null` value, that `null` value is converted to the empty string (`""`), so `sr.innerHTML = null` is equivalent to `sr.innerHTML = ""`.

## Examples

```js
Expand Down
2 changes: 2 additions & 0 deletions files/en-us/web/api/window/open/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ open(url, target, windowFeatures)
- `noreferrer`
- : If this feature is set, the browser will omit the [`Referer`](/en-US/docs/Web/HTTP/Headers/Referer) header, as well as set `noopener` to true. See [`rel="noreferrer"`](/en-US/docs/Web/HTML/Attributes/rel/noreferrer) for more information.

A ["null"](/en-US/docs/Web/JavaScript/Reference/Operators/null) value is treated the same as the empty string (`""`).
teoli2003 marked this conversation as resolved.
Show resolved Hide resolved

> **Note:** Requested position (`top`, `left`), and requested dimension (`width`, `height`) values in `windowFeatures` **will be corrected** if any of such requested value does not allow the entire browser popup to be rendered within the work area for applications of the user's operating system. In other words, no part of the new popup can be initially positioned offscreen.

### Return value
Expand Down