Skip to content
This repository has been archived by the owner on Jul 30, 2019. It is now read-only.

Fix Bikeshed Warnings #1218

Merged
merged 24 commits into from
Feb 22, 2018
Merged

Fix Bikeshed Warnings #1218

merged 24 commits into from
Feb 22, 2018

Conversation

edent
Copy link
Member

@edent edent commented Feb 17, 2018

Fixes #1215 - commit to this branch and tick them off in that issue.

WARNING: The following (probably auto-generated) link is illegally nested in another link: `<a data-link-type="idl" href="#htmlmediaelement" id="ref-for-htmlmediaelement&#9317;" data-silently-dedup="">HTMLMediaElement</a>`

Re #1215
@edent
Copy link
Member Author

edent commented Feb 18, 2018

This takes us down to 29 errors (from 50). I can't do any more because I don't understand bikeshed well enough.

@chaals chaals self-requested a review February 18, 2018 11:15
@chaals
Copy link
Collaborator

chaals commented Feb 19, 2018

reviewing. Expect to be done Wednesday...

Copy link
Collaborator

@chaals chaals left a comment

Choose a reason for hiding this comment

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

Please check these.

@@ -494,7 +494,7 @@
internal slot's value.
16. If the <{script}> element has an <{script/integrity}> attribute, then let <var>integrity metadata</var> be that attribute's value.
Otherwise, let <var>integrity metadata</var> be the empty string.
17. Let <var>parser metadata</var> be "<code>parser-inserted</code>" if the <{script}> element has been flagged
17. Let <var ignore=''>parser metadata</var> be "<code>parser-inserted</code>" if the <{script}> element has been flagged
Copy link
Collaborator

Choose a reason for hiding this comment

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

why ignore? Shouldn't the mention in the step below refer to the var?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@@ -494,7 +494,7 @@
internal slot's value.
16. If the <{script}> element has an <{script/integrity}> attribute, then let <var>integrity metadata</var> be that attribute's value.
Otherwise, let <var>integrity metadata</var> be the empty string.
17. Let <var>parser metadata</var> be "<code>parser-inserted</code>" if the <{script}> element has been flagged
17. Let <var ignore=''>parser metadata</var> be "<code>parser-inserted</code>" if the <{script}> element has been flagged
as "[=parser-inserted=]", and "`not parser-inserted`" otherwise.
18. Let options be a set of <a>script fetch options</a> whose <a>cryptographic nonce metadata</a> is
cryptographic nonce, <a>integrity metadata</a> is integrity metadata,
Copy link
Collaborator

Choose a reason for hiding this comment

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

here, the second "integrity metadata" should be a var - and the last "parser metadata" too, no?

@@ -42,8 +42,8 @@
The <{p}> element should not be used when a more specific element, such as a list, is more appropriate.

<div class="note">
Many elements whose typical <a>rendering</a> is a block cannot be children of <{p}> elements,
because when the parser finds them it automatically closes the <{p}> element - effectively inserting a <code>&lt;/p&gt;</code> tag.
Many elements whose typical rendering is a block, cannot be children of <{p}> elements.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would remove the comma too, but that's pretty editorial...

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@@ -3316,7 +3316,7 @@ It covers
the document.

The <dfn export>rules for parsing a hash-name reference</dfn> to an element of type <var>type</var>,
given a context node <var>scope</var>, are as follows:
given a context node <var ignore=''>scope</var>, are as follows:
Copy link
Collaborator

Choose a reason for hiding this comment

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

since scope is not used in the algorithm, it makes more sense just to remove it, or check whether something is missing.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@@ -3851,7 +3851,7 @@ It covers
</ol>
</div>

<h4 id="nonce-attributes">Nonce attributes</h4>
<h4 id="nonce-attributes"><dfn>Nonce</dfn> attributes</h4>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't nonce defined just below? Why the extra dfn?

Copy link
Member Author

Choose a reason for hiding this comment

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

If I don't add that dfn, I get LINK ERROR: No 'dfn' refs found for 'nonce'.<a data-link-type="dfn" data-lt="nonce">nonce</a>
This may be down to me not fully understanding bikeshed cross references.

@@ -3908,7 +3908,7 @@ interface NoncedElement {

<p class="note">As each {{Document}}'s [=response/CSP list=] is append-only, user agents can optimize away the <a>contains a header-delivered
Content Security Policy</a> check by, for example, holding a flag on the {{Document}},
set during <a>Document initialization</a>.</p>
set during Document initialization.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should the reference be to https://w3c.github.io/html/browsers.html#initializing-a-new-document-object - maybe adding an alternate term there would be better.

or set when <a>initializing a new document object</a> ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

Copy link
Collaborator

@chaals chaals left a comment

Choose a reason for hiding this comment

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

OK, let's commit these and then go after the remaining ones...

@chaals chaals merged commit 51b984a into master Feb 22, 2018
@edent edent deleted the 1215-warnings-edent branch October 17, 2018 15:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants