Skip to content

Commit 5383a2e

Browse files
cscottsaschanaz
andauthored
chore(README): Update documentation for the special field (#534)
One part of the README still uses the old separate static, stringifier, and inherit fields. In other places it is stated that the special field is null in the default case, when in fact the special field is set to the empty string. Closes: #533 Co-authored-by: Kagami Sascha Rosylight <[email protected]>
1 parent 32b9e2d commit 5383a2e

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ An operation looks like this:
536536
The fields are as follows:
537537

538538
* `type`: Always "operation".
539-
* `special`: One of `"getter"`, `"setter"`, `"deleter"`, `"static"`, `"stringifier"`, or `null`.
539+
* `special`: One of `"getter"`, `"setter"`, `"deleter"`, `"static"`, `"stringifier"`, or `""`.
540540
* `idlType`: An [IDL Type](#idl-type) of what the operation returns, if exists.
541541
* `name`: The name of the operation if exists.
542542
* `arguments`: An array of [arguments](#arguments) for the operation.
@@ -583,9 +583,7 @@ An attribute member looks like this:
583583
```JS
584584
{
585585
"type": "attribute",
586-
"static": null,
587-
"stringifier": null,
588-
"inherit": null,
586+
"special": "",
589587
"readonly": false,
590588
"idlType": {
591589
"type": "attribute-type",
@@ -605,7 +603,7 @@ The fields are as follows:
605603

606604
* `type`: Always "attribute".
607605
* `name`: The attribute's name.
608-
* `special`: One of `"static"`, `"stringifier"`, `"inherit"`, or `null`.
606+
* `special`: One of `"static"`, `"stringifier"`, `"inherit"`, or `""`.
609607
* `readonly`: `true` if the attribute is read-only.
610608
* `idlType`: An [IDL Type](#idl-type) for the attribute.
611609
* `extAttrs`: An array of [extended attributes](#extended-attributes).

0 commit comments

Comments
 (0)