Rely on the IDL definitions for dictionary members. #304
Conversation
Before this change dictionaries and their members were defined in IDL blocks, then the members were redefined using `<dfn>` elements inside `<dl>`. After this change the `<dfn>` and `<dl>`'s are removed; instead the IDL definitions of the members are referenced. Additionally, this change reuses the styles for the domintro class from the WHATWG styles. Notably, this adds "For web developers (non-normative)" as a heading to each domintro block. See issue w3c#302.
|
(This is not my speciality so I defer.) |
|
Just to check, this is not currently marked as having any reviewers - @pejic , were you looking for it to be reviewed? |
There was a check failure that I was going to find the time to resolve; however, the checks do pass now: So review can begin. I will add you, Stephen, to review. |
| @@ -122,6 +122,93 @@ spec:html; type:dfn; for:environment settings object; text:origin | |||
| } | |||
| </pre> | |||
|
|
|||
| <style> | |||
There was a problem hiding this comment.
I don't love us pulling in random stylesheets generally (I understand from Slobodan that this is a stylesheet that the WHATWG uses, and that other bikeshed specs - maybe WICG - have perhaps adopted). If its useful, it feels like it should just be provided/used by bikeshed by default.
What do you think, @tabatkins ?
There was a problem hiding this comment.
Yeah, I have an open issue to help support domintro blocks. Tho there's more work to do for completeness, just pulling in the stylesheet when you use the class would be a trivial patch.
| padding-bottom: 0.15em; | ||
| } | ||
|
|
||
| dl.domintro::before { content: 'For web developers (non-normative)'; } |
There was a problem hiding this comment.
I also don't love that this marks the descriptions as non-normative. Generally I would agree that that is best behavior (it's confusing otherwise), but what about members like locale which are described/defined as:
An optional list of well-formed [[BCP47]] language tags, in descending
order of priority, that identify the [=locale=] preferences of the
website, i.e. a [=language priority list=] [[RFC4647]] ...
With this change, that becomes non-normative, and so in theory one needs additional spec text in the algorithms to ensure that the locale member is formed as described. That may actually be better, but we would need to do it ahead of this change or in one swap.
(No action for this second comment atm, just making sure I don't forget this for when I review later).
Before this change dictionaries and their members were defined in IDL blocks, then the members were redefined using
<dfn>elements inside<dl>. After this change the<dfn>and<dl>'s are removed; instead the IDL definitions of the members are referenced.Additionally, this change reuses the styles for the domintro class from the WHATWG styles. Notably, this adds "For web developers (non-normative)" as a heading to each domintro block.
See issue #302.
Preview | Diff