Skip to content

fix: ReSpec link warnings #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 30, 2017
Merged

fix: ReSpec link warnings #54

merged 9 commits into from
Nov 30, 2017

Conversation

marcoscaceres
Copy link
Member

@marcoscaceres marcoscaceres commented Nov 27, 2017

@marcoscaceres
Copy link
Member Author

We should probably define the errors in a dependencies section, as it would clean up quite a bit of markup.

Let me know if you want me to do that...

Also, should "en-US" a few words 😱, as eventually we will need to do that for w3c (requirement that documents be in US English).

@marcoscaceres marcoscaceres requested a review from mgiuca November 27, 2017 02:06
index.html Outdated
<h3>
<code>Navigator</code> interface
</h3>
<p>
The <code><dfn data-cite="!HTML#navigator">Navigator</dfn></code>
interface is defined in [[!HTML]].
The <dfn data-cite="!HTML#navigator">Navigator</dfn> interface is
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woopsy, this one was fine.

@marcoscaceres
Copy link
Member Author

Found a few other little things to fix... brb

@marcoscaceres
Copy link
Member Author

OK, should be all good now for review :)

USVString url;
};
</pre>
<p>
The <dfn>ShareData</dfn> dictionary consists of several optional
fields:
members:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the spec, you use "fields" throughout... but in IDL, I think these are called members.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will file a separate bug for this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack.

Copy link
Collaborator

@mgiuca mgiuca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably define the errors in a dependencies section, as it would clean up quite a bit of markup.

Let me know if you want me to do that...

I'm not quite sure what you mean (is it just adding an errors section to the end so I don't have to write long hrefs?). Go ahead and do it in this CL if you think it helps and is easy. I'm also happy to keep it as-is.

index.html Outdated
When the <dfn>share</dfn> method is called with argument
<var>data</var>, run the following steps:
When the <a>share()</a> method is called with argument
<a>ShareData</a> <var>data</var>, run the following steps:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this needs to say ShareData here (it seems very unconventional to specify a data type when defining an argument to an algorithm).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Np. I'll remove that. I've seen it as a trend I think in the WHATWG specs.

index.html Outdated
p</var> with <a data-cite=
"!WEBIDL#aborterror"><code>AbortError</code></a>, and abort
these steps.
p</var> with "<a>AbortError</a>" <a>DOMException</a>, and
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified that "AbortError" isn't an error class, it's a DOMException type. Same with "NotAllowedError".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Can you be consistent with NotAllowedError and say "an "AbortError" DOMException" (i.e., add "an" in front of AbortError).

@marcoscaceres
Copy link
Member Author

I'm not quite sure what you mean (is it just adding an errors section to the end so I don't have to write long hrefs?). Go ahead and do it in this CL if you think it helps and is easy. I'm also happy to keep it as-is.

Added Dependencies section with links to the various common IDL things. Can probably leave the rest, as everything links directly into the WebIDL spec.

Copy link
Collaborator

@mgiuca mgiuca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I wrote a few comments.

index.html Outdated
p</var> with <a data-cite=
"!WEBIDL#aborterror"><code>AbortError</code></a>, and abort
these steps.
p</var> with "<a>AbortError</a>" <a>DOMException</a>, and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Can you be consistent with NotAllowedError and say "an "AbortError" DOMException" (i.e., add "an" in front of AbortError).

index.html Outdated
p</var> with <a data-cite=
"!WEBIDL#aborterror"><code>AbortError</code></a>, and abort
these steps.
p</var> with "<a>AbortError</a>" <a>DOMException</a>, and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"an"

index.html Outdated
p</var> with <a data-cite=
"!WEBIDL#aborterror"><code>AbortError</code></a>, and abort
these steps.
p</var> with "<a>AbortError</a>" <a>DOMException</a>, and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"an"

USVString url;
};
</pre>
<p>
The <dfn>ShareData</dfn> dictionary consists of several optional
fields:
members:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack.

index.html Outdated
</li>
<li>
<code><dfn data-cite=
"!WEBIDL#notallowederror">NotAllowedError</dfn></code>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the period at the end here. (Or add periods to all of them.)

index.html Outdated
<ul data-sort="">
<li>
<code><dfn data-cite=
"!WEBIDL#exceptiondef-typeerror">TypeError</dfn></code>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we could instead link to https://tc39.github.io/ecma262/#sec-native-error-types-used-in-this-standard-typeerror which is where TypeError is actually defined? WebIDL just refers to that. Maybe web specs don't normally directly link to ECMA-262. This is fine also.

@marcoscaceres
Copy link
Member Author

Hopefully all good now :)

@marcoscaceres
Copy link
Member Author

oooh... hang on.... broke something...

@marcoscaceres
Copy link
Member Author

Better 🤪

@marcoscaceres
Copy link
Member Author

Ok, if you are good with this, please merge.

Spec is looking really good btw! Really easy to read and follow.

Any plans to migrate this to a W3C WG? Mozilla aside, have you gotten any interest from the folks at Microsoft?

index.html Outdated
USVString text;
USVString title;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, why did the order change? Are you just making it alphabetical? I'd prefer to keep it in order title > text > url, since that's the order I think developers should supply them if supplying them all. (That's the order that a receiver will normally display them.)

(Note that WebIDL dictionaries don't care what the order is, so this decision isn't normative, just presentational.)

Copy link
Collaborator

@mgiuca mgiuca Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, sorry... just saw this... was alphabetical, will revert.

@mgiuca
Copy link
Collaborator

mgiuca commented Nov 28, 2017

Any plans to migrate this to a W3C WG?

I think if Mozilla is going to implement then it makes sense to move this out of WICG. Do you have a proposed WG?

have you gotten any interest from the folks at Microsoft?

No, not lately. I will ping them again.

@marcoscaceres
Copy link
Member Author

Either Web Platform WG or the new Device APIs WG (cc @anssiko), where the original work on Web Intents took place IIRC.

@marcoscaceres
Copy link
Member Author

@mgiuca, can we merge?

@marcoscaceres
Copy link
Member Author

Ok, put USVString title; back at top :)

@mgiuca
Copy link
Collaborator

mgiuca commented Nov 30, 2017

Great, thanks!

@mgiuca mgiuca merged commit 2ce56e5 into master Nov 30, 2017
@marcoscaceres marcoscaceres deleted the linkin branch November 30, 2017 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants