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

"in parallel" in algorithm headers can be confusing #10049

Open
domenic opened this issue Jan 11, 2024 · 2 comments
Open

"in parallel" in algorithm headers can be confusing #10049

domenic opened this issue Jan 11, 2024 · 2 comments
Labels
clarification Standard could be clearer

Comments

@domenic
Copy link
Member

domenic commented Jan 11, 2024

What is the issue with the HTML Standard?

Sometimes we have algorithms where the entire algorithm runs in parallel. Often, instead of writing the algorithm as

To do X:

1. Perform the following steps in parallel:
   1. ...
   2. ...
   3. ...
   4. ...

we write

To do X, perform the following steps in parallel:

1. ...
2. ...
3. ...
4. ...

However, this can be confusing. It's easy to visually miss the in-parallelness of the steps.

Should we consider moving to the former style, even though it's a bit ugly?

Cases of this I found in the spec:

/cc @domfarolino

@domenic domenic added the clarification Standard could be clearer label Jan 11, 2024
@annevk
Copy link
Member

annevk commented Jan 11, 2024

I think this also applies to "switching" and maybe some other things we sometimes inline.

If it makes it harder to read for folks I'm not opposed to inline less. And generally we probably should as we also try to put more in the algorithm header such as types and often return types (although return types don't apply to in parallel of course).

@TallTed
Copy link

TallTed commented Nov 25, 2024

"In parallel" has a common meaning in English, which does not match the intended meaning here.

"Run the following steps in parallel" would usually mean, "run each of these steps in parallel with the others", not "run these steps as a sequence, in parallel with any other actions, sequences, functions, etc."

The whole Parallelism section needs some revision, such that run this list of steps in parallel (which implies with each other) is no longer used to mean run these actions in series, in parallel with actions not in this list.

I discovered this issue while trying to address a confusing section of FedCM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification Standard could be clearer
Development

No branches or pull requests

3 participants