Skip to content

Commit 5cc1532

Browse files
cscottsaschanaz
andauthored
chore(README): Describe the inheritance field consistently (#530)
Closes: #529 Co-authored-by: Kagami Sascha Rosylight <[email protected]>
1 parent 2e0b124 commit 5cc1532

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,12 +280,14 @@ Interfaces mixins look like this:
280280
{
281281
"type": "interface mixin",
282282
"name": "Animal",
283+
"inheritance": null,
283284
"partial": false,
284285
"members": [...],
285286
"extAttrs": [...]
286287
}, {
287288
"type": "interface mixin",
288289
"name": "Human",
290+
"inheritance": null,
289291
"partial": false,
290292
"members": [...],
291293
"extAttrs": [...]
@@ -296,6 +298,7 @@ The fields are as follows:
296298

297299
* `type`: Always "interface mixin".
298300
* `name`: The name of the interface mixin.
301+
* `inheritance`: Always `null`.
299302
* `partial`: `true if the type is a partial interface mixin.
300303
* `members`: An array of interface members (attributes, operations, etc.). Empty if there are none.
301304
* `extAttrs`: An array of [extended attributes](#extended-attributes).
@@ -308,6 +311,7 @@ Namespaces look like this:
308311
{
309312
"type": "namespace",
310313
"name": "console",
314+
"inheritance": null,
311315
"partial": false,
312316
"members": [...],
313317
"extAttrs": [...]
@@ -318,6 +322,7 @@ The fields are as follows:
318322

319323
* `type`: Always "namespace".
320324
* `name`: The name of the namespace.
325+
* `inheritance`: Always `null`.
321326
* `partial`: `true if the type is a partial namespace.
322327
* `members`: An array of namespace members (attributes and operations). Empty if there are none.
323328
* `extAttrs`: An array of [extended attributes](#extended-attributes).

0 commit comments

Comments
 (0)