Skip to content
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

Editorial: Link to continue description #7060

Merged
merged 9 commits into from Oct 12, 2021

Conversation

heppokofrontend
Copy link
Contributor

@heppokofrontend heppokofrontend commented Sep 12, 2021

I linked to https://infra.spec.whatwg.org/#iteration-continue from continue to make it more clear.

I am grateful to Domenic Denicola for pointing out that I had misunderstood the meaning of continue on Twitter.


/acknowledgements.html ( diff )
/common-microsyntaxes.html ( diff )
/form-control-infrastructure.html ( diff )
/images.html ( diff )
/microdata.html ( diff )
/parsing.html ( diff )

I linked to https://infra.spec.whatwg.org/#iteration-continue from
continue to make it more clear.
Copy link
Member

@domenic domenic left a comment

Choose a reason for hiding this comment

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

Thanks for this! However, you have edited review-drafts/2021-01.wattsi, and you need to instead edit source.

Additionally, it might be worth searching for other instances of Continue. and linking them in the same PR. That is optional though.

review-drafts/2021-01.wattsi Outdated Show resolved Hide resolved
Copy link
Contributor Author

@heppokofrontend heppokofrontend left a comment

Choose a reason for hiding this comment

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

Thanks for this! However, you have edited review-drafts/2021-01.wattsi, and you need to instead edit source.

Sorry, I did a revert...

Additionally, it might be worth searching for other instances of Continue. and linking them in the same PR. That is optional though.

I understand.
I'll check to see if there are any other unlinked Continues.

I'll notify you again when I'm done!

review-drafts/2021-01.wattsi Outdated Show resolved Hide resolved
I linked to https://infra.spec.whatwg.org/#iteration-continue from
continue to make it more clear.
@heppokofrontend
Copy link
Contributor Author

@domenic I have marked up all the "continues" that I could find with the span element!
But, I have a question.

Is "continue" in line 56604 and 56613 are meaning a variable? Or is it a statement?

image

Copy link
Member

@domenic domenic left a comment

Choose a reason for hiding this comment

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

Is "continue" in line 56604 and 56613 are meaning a variable? Or is it a statement?

These are variables, so no need to change them! They could be written as <var>shouldContinue</var> if that would be clearer?

I guess maybe the confusing thing here is that there are generally two senses in which specs use the word continue:

  1. "Continue to the next part of the algorithm", i.e., don't return or throw an error or anything like that.
  2. "Continue to the next iteration of the loop, skipping any subsequent steps in the loop body".

What I like about your PR is that it links all cases of (2) directly to the definition. Hopefully then it is clear that any unlinked case really means (1).

source Outdated
@@ -28416,7 +28416,7 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
<li><p>If another instance of this algorithm for this <code>img</code> element was started after this instance
(even if it aborted and is no longer running), then return.</p></li>

<li><p><span>Queue a microtask</span> to continue this algorithm.</p></li>
<li><p><span>Queue a microtask</span> to <span>continue</span> this algorithm.</p></li>
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm sorry, I fixed !

source Outdated
@@ -28497,7 +28497,7 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
</li>

<li><p><span>Queue a microtask</span> to perform the rest of this algorithm, allowing the <span
data-x="concept-task">task</span> that invoked this algorithm to continue.</p></li>
data-x="concept-task">task</span> that invoked this algorithm to <span>continue</span>.</p></li>
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed.

@@ -29281,15 +29281,15 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
from the end of <var>unparsed size</var>.
If <var>unparsed size</var> is now empty,
that is a <span data-x="concept-microsyntax-parse-error">parse error</span>;
continue to the next iteration of this algorithm.</p></li>
<span>continue</span> to the next iteration of this algorithm.</p></li>
Copy link
Member

Choose a reason for hiding this comment

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

Let's just say <span>continue</span> here, removing the "to the next iteration of this algorithm" since that is clear from the definition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed it that way.
I have an English question, should I it as follows in this case?

  • <span>Continue</span>.
  • Then <span>continue</span>.

If it's just a minor difference, I will keep this!

Copy link
Member

Choose a reason for hiding this comment

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

What you did here is perfect as-is, with lowercase <span>continue</span>. This is because of the semicolon ;. We would use "then" after a comma ,.

Line 56990 is a bit of an exception to this general principle but somehow it reads OK anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you kindly! I've learned them!


<li><p>If the last <span>component value</span> in <var>unparsed size</var>
is a valid non-negative <span>&lt;source-size-value></span>,
let <var>size</var> be its value
and remove the <span>component value</span> from <var>unparsed size</var>.
Any CSS function other than the <span>math functions</span> is invalid.
Otherwise, there is a <span data-x="concept-microsyntax-parse-error">parse error</span>;
continue to the next iteration of this algorithm.</p></li>
<span>continue</span> to the next iteration of this algorithm.</p></li>
Copy link
Member

Choose a reason for hiding this comment

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

Let's just say <span>continue</span> here, removing the "to the next iteration of this algorithm" since that is clear from the definition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed it that way.

@@ -29302,7 +29302,7 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
as a <span>&lt;media-condition></span>.
If it does not parse correctly,
or it does parse correctly but the <span>&lt;media-condition></span> evaluates to false,
continue to the next iteration of this algorithm. <ref spec=MQ></p></li>
<span>continue</span> to the next iteration of this algorithm. <ref spec=MQ></p></li>
Copy link
Member

Choose a reason for hiding this comment

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

Let's just say <span>continue</span> here, removing the "to the next iteration of this algorithm" since that is clear from the definition.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed it that way.

source Outdated
@@ -29427,7 +29427,7 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
<li>
<p>If the <span>list of available images</span> contains an entry for <var>key</var>,
then set <var>image request</var>'s <span data-x="img-req-data">image data</span> to that of the entry.
Continue to the next step.</p>
<span>Continue</span> to the next step.</p>
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed.

source Outdated
@@ -33843,7 +33843,7 @@ interface <dfn interface>MediaError</dfn> {
(this <span data-x="delay the load event">delays the load event</span>).</p></li>

<li><p><span>Await a stable state</span>, allowing the <span
data-x="concept-task">task</span> that invoked this algorithm to continue. The <span>synchronous
data-x="concept-task">task</span> that invoked this algorithm to <span>continue</span>. The <span>synchronous
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed.

source Outdated
@@ -93677,7 +93677,7 @@ import "https://example.com/foo/../module2.mjs";</code></pre>
<p>Stop <var>task</var>, allowing whatever algorithm that invoked it to resume.</p>

<p class="note">This causes the <span>event loop</span>'s main set of steps or the <span>perform
a microtask checkpoint</span> algorithm to continue.</p>
a microtask checkpoint</span> algorithm to <span>continue</span>.</p>
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed.

source Outdated
@@ -96093,7 +96093,7 @@ enum <dfn enum>DOMParserSupportedType</dfn> {
<li><p>Let <var>task</var>'s <dfn>timer nesting level</dfn> be <var>nesting
level</var>.</p></li>

<li><p>Return <var>handle</var>, and then continue running this algorithm
<li><p>Return <var>handle</var>, and then <span>continue</span> running this algorithm
Copy link
Member

Choose a reason for hiding this comment

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

This is not correct; here we're not in a loop but instead using "continue" in a different sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed.

@heppokofrontend
Copy link
Contributor Author

@domenic

These are variables, so no need to change them! They could be written as <var>shouldContinue</var> if that would be clearer?

I fixed it that way!

I guess maybe the confusing thing here is that there are generally two senses in which specs use the word continue:

  1. "Continue to the next part of the algorithm", i.e., don't return or throw an error or anything like that.
  2. "Continue to the next iteration of the loop, skipping any subsequent steps in the loop body".

Yes, For a beginner in English like me, it is difficult to understand difference the meaning of "Continue" in a sentence...
That's why I want to fix document to be as clear as possible with this PR!

What I like about your PR is that it links all cases of (2) directly to the definition. Hopefully then it is clear that any unlinked case really means (1).

Thanks for like this PR, and for your review comments!
I'm happy to contribute to HTML Spec.

Please let me know if there is anything else I should fix!

Copy link
Member

@domenic domenic left a comment

Choose a reason for hiding this comment

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

Looks great, thanks again!

Can you sign the agreement at https://participate.whatwg.org/agreement ? Then we will merge this.

@@ -29281,15 +29281,15 @@ was an English &lt;a href="/wiki/Music_hall">music hall&lt;/a> singer, ...</code
from the end of <var>unparsed size</var>.
If <var>unparsed size</var> is now empty,
that is a <span data-x="concept-microsyntax-parse-error">parse error</span>;
continue to the next iteration of this algorithm.</p></li>
<span>continue</span> to the next iteration of this algorithm.</p></li>
Copy link
Member

Choose a reason for hiding this comment

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

What you did here is perfect as-is, with lowercase <span>continue</span>. This is because of the semicolon ;. We would use "then" after a comma ,.

Line 56990 is a bit of an exception to this general principle but somehow it reads OK anyway.

@heppokofrontend
Copy link
Contributor Author

heppokofrontend commented Sep 16, 2021

@domenic

Can you sign the agreement at https://participate.whatwg.org/agreement ? Then we will merge this.

Excuse me, I've read it.

I actually work for a company building websites, but the series of activities on here I've done so far are completely private and personal.

Still, is there any problem in choosing the following?

I represent that I do not work in the field of web technologies as an employee, contractor, or agent of another person or legal entity, and make this Agreement in my personal capacity only.

Also, the name in the signature should be not a account name or handle name, right? (I feel awkward asking this question personally... 🙈)

@domenic
Copy link
Member

domenic commented Sep 16, 2021

Still, is there any problem in choosing the following?

There is no problem with choosing that in your case.

What's important is actually not whether the activities are private or personal. Instead, we care about whether your job role is in the field of web technologies, as defined here:

"Field of Web Technologies" means the field of creating and influencing web standards and web technologies that could be adopted by the web community. "Field of web technologies" does not include implementation of web standards solely for the purpose of creating a website or app.

It sounds like you fall into the last category, so choosing the individual option in the agreement is good!

Also, the name in the signature should be not a account name or handle name, right?

Right, it should be the name you usually use to sign contracts with.

@heppokofrontend
Copy link
Contributor Author

heppokofrontend commented Sep 16, 2021

@domenic Thank you! I've send!

But, I wrote my name wrong...

@domenic
Copy link
Member

domenic commented Sep 16, 2021

You can edit your signature by sending a pull request that modifies https://github.com/whatwg/participant-data/blob/main/individuals.json

@heppokofrontend
Copy link
Contributor Author

@domenic It's solved! Sorry I was too busy to reply.

It is signed!

@domenic
Copy link
Member

domenic commented Oct 12, 2021

@heppokofrontend so sorry for the delay! I went on vacation just as you resolved the issue on your end. My apologies for a long road to getting this landed.

@domenic domenic merged commit e270c0a into whatwg:main Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants