Make sure all IDL members have "dfn" in prose #397
Comments
markafoltz
pushed a commit
that referenced
this issue
Jan 5, 2017
* Issue 397 - Make sur all IDL terms have <dfn> in prose Done: - All IDL terms have <dfn> in prose - Added constructor logic for custom Events - Added missing reference to Web Messaging spec - Linked terms to definition whenever possible - Improved support for linking to methods with parentheses: "start()" - Occurrences of "presentation" that should link to "controlling browsing context" now effectively link to it - Occurrences of "Presentation" that should link to the interface definition now effectively link to it Notes: - No way to define an idiom "presentation" and an interface "Presentation" using ReSpec, so "presentation" (as an idiom) links are hardcoded - Some definitions are not real definitions (e.g. BinaryType is merely defined as the type of the binaryType attribute), but they do not seem to warrant proper definitions. - Description of custom events constructors could be turned into real algorithms but that seems straightforward enough not to require crisper language. * Tidy
|
I believe this should be addressed by PR #403. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
ReSpec shipped a new feature yesterday that warns about missing definitions in prose for IDL members.
ReSpec now reports 25 warnings on the Presentation API, some of them we should fix (e.g.
binaryType,connectionproperties). Now, ReSpec also complains about the interface names themselves, where it makes sense to me to have the IDL be the definition, as done in the Presentation API. I filed an issue against ReSpec: https://github.com/w3c/respec/issues/997The text was updated successfully, but these errors were encountered: