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

Suggestion: rephrase or quote “perform the fetch” hook #7171

Closed
j9t opened this issue Oct 6, 2021 · 2 comments
Closed

Suggestion: rephrase or quote “perform the fetch” hook #7171

j9t opened this issue Oct 6, 2021 · 2 comments

Comments

@j9t
Copy link
Contributor

j9t commented Oct 6, 2021

This is not limited to “perform the fetch” but the problem got visible here: The way this hook is presented, it leads to a slow and sometimes confusing reading experience. Some snippets, without links so to highlight the problem:

  • “asynchronously complete the perform the fetch steps”
  • “not supplying the perform the fetch”
  • “If the caller of this algorithm specified custom perform the fetch steps”

Here but also in related cases, rephrasing or quoting the respective hook or algorithm could make the spec easier to read and understand:

  • “asynchronously complete the steps to perform the fetch”
  • ‘not supplying the “perform the fetch” hook’
  • “If the caller of this algorithm specified custom perform-the-fetch steps”
@j9t
Copy link
Contributor Author

j9t commented Oct 6, 2021

(Another example: “used in conjunction with the create an element for the token algorithm”)

@domenic
Copy link
Member

domenic commented Oct 7, 2021

I don't see how the latter are any easier to read than the former; the existing text in fact seems simpler to me (although perhaps there's a missing word "steps" in the second example, but without context I can't tell if that was just snipped).

@annevk annevk closed this as completed Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants