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: rename "basic fetch" to "scheme fetch" #537

Merged
merged 1 commit into from May 5, 2017

Conversation

jugglinmike
Copy link
Contributor

@jugglinmike jugglinmike commented May 3, 2017

As it relates to the fetching algorithm, the term "basic" is sub-optimal
for a number of reasons:

  • It implies a relative level of simplicity. Because the algorithm
    includes an invocation of HTTP Fetch, it is conceptually more complex
    than most other fetching algorithms defined in the specification.
  • It suggests a relationship to the "basic" request tainting value and
    "basic" filtered response. While the algorithm is invoked for requests
    whose tainting is "basic", it is also invoked for requests whose
    tainting is set to "opaque".

Re-name the algorithm to "scheme fetch" in order to more precisely
describe its behavior while avoiding association with any particular
request tainting value.


@annevk I'm probably only thinking along these lines because of my inexperience
with the specification, but I know that same inexperience makes it easier for
me to stomach vocabulary changes like this. These details certainly have
momentum for folks who have been working in this space for a while. My bias
notwithstanding, I do think this would make the text easier to follow. Other
alternatives that would address my concern are "scheme fetch" or "scheme-based
fetch", though those may be too technical/wordy.


Preview | Diff

@annevk
Copy link
Member

annevk commented May 4, 2017

I like "scheme fetch". We should probably not change the IDs though or at the very least preserve the old IDs. The for attribute used for this should also be removed throughout. If you could take care of that while you're there that would be great.

@jugglinmike jugglinmike force-pushed the generic-fetch branch 2 times, most recently from 25b687b to d9b8f6a Compare May 4, 2017 16:37
@jugglinmike
Copy link
Contributor Author

Sure thing. This required amending the commit message, so I've made the original version of this branch (including a fixup commit with the requested changes) available here: master...bocoup:generic-fetch-orig

Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

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

Thanks, looking good.

fetch.bs Outdated
<!-- Prior to May 2017, this algorithm was named "basic fetch." The
corresponding ID is maintained in order to preserve the functionality of
external references. -->
<h3 id=scheme-fetch><span id=basic-fetch>Scheme fetch</span></h3>
Copy link
Member

Choose a reason for hiding this comment

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

<h3 id=scheme-fetch oldids=basic-fetch>.

fetch.bs Outdated
<h3 id=basic-fetch>Basic fetch</h3>

<p>To perform a <dfn id=concept-basic-fetch for=basic>basic fetch</dfn> using
<p>To perform a <dfn id=concept-scheme-fetch>scheme fetch</dfn> using
Copy link
Member

Choose a reason for hiding this comment

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

Add oldids=concept-basic-fetch here too. I suspect both of these to have external links.

As it relates to the fetching algorithm, the term "basic" is sub-optimal
for a number of reasons:

- It implies a relative level of simplicity. Because the algorithm
  includes an invocation of HTTP Fetch, it is conceptually more complex
  than most other fetching algorithms defined in the specification.
- It suggests a relationship to the "basic" request tainting value and
  "basic" filtered response. While the algorithm is invoked for requests
  whose tainting is "basic", it is also invoked for requests whose
  tainting is set to "opaque".

Re-name the algorithm to "scheme fetch" in order to more precisely
describe its behavior while avoiding association with any particular
request tainting value.
@jugglinmike
Copy link
Contributor Author

Wow, Bikeshed is a great tool! I've shorted the accompanying comment as it is now clear that this practice is pretty common. Force-pushed to facilitate merging, but the individual commits are available on the branch I reference above.

@jugglinmike jugglinmike changed the title Editorial: rename "basic fetch" to "generic fetch" Editorial: rename "basic fetch" to "scheme fetch" May 4, 2017
@annevk annevk merged commit ef03683 into whatwg:master May 5, 2017
@annevk
Copy link
Member

annevk commented May 5, 2017

Thanks!

@jugglinmike
Copy link
Contributor Author

Sure thing :)

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