spec: Make ShareData argument optional. #51
Conversation
|
@sammc ptal. Web platform tests updated here: web-platform-tests/wpt@master...mgiuca:web-share-errors-and-arguments |
index.html
Outdated
| <a data-cite= | ||
| "!WEBIDL#exceptiondef-typeerror"><code>TypeError</code></a> if called | ||
| with no arguments. WebIDL <a data-cite= | ||
| "!WEBIDL#idl-operations">mandates that it be optional</a>, because |
index.html
Outdated
| }; | ||
| </pre> | ||
| <div class="note"> | ||
| The <var>data</var> argument is marked as "optional", but really it |
There was a problem hiding this comment.
Shane suggested I write a comment explaining why this is here, since it's quite unintuitive to have an optional argument that is mandatory.
In particular, I think while developers may not read the whole spec, the one thing that is fairly understandable to a non-web-spec person is IDL, so we may have confused developers reading the IDL and wondering why this is "optional". That's why I'm so strongly opposed to adding a misleading "optional" here, but if we are going to have it, I'd rather explain it.
If you'd like I can reduce the amount of text here and perhaps convert it into a // comment in the IDL itself rather than a note.
There was a problem hiding this comment.
I meant just the word "really." The rest is fine.
There was a problem hiding this comment.
Oh lol, use quotes next time. (I read it as "This really feel a bit superfluous".)
index.html
Outdated
| }; | ||
| </pre> | ||
| <div class="note"> | ||
| The <var>data</var> argument is marked as "optional", but really it |
There was a problem hiding this comment.
I meant just the word "really." The rest is fine.
This has no behavioural change, as passing an empty dictionary is a TypeError. But it is required by the WebIDL spec. Closes w3c#47.
This has no behavioural change, as passing an empty dictionary is a
TypeError. But it is required by the WebIDL spec.
Closes #47.
Preview | Diff