-
Notifications
You must be signed in to change notification settings - Fork 323
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: Reword how-to section to explain how to use callbacks & controller #1614
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, thanks! I think we should also run it by a couple of the more novice specification authors who have wondered how to integrate with Fetch recently, to see if it answers their questions. I'll send it to a couple once you've had a chance to integrate or disagree with my comments here.
Thanks! I accepted all your suggestions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few final comments:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your work on this!
There's two outstanding comments from @jyasskin as well that need to be addressed, though note that one is slightly incorrect with respect to URLs being strings.
Generally I would not talk about "downloading" here as that's its own term of art within the context of navigation. Fetch fetches or obtains.
To set expectations, this needs at least one more close look after these issues are addressed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of editorial nits... please keep these sorts of things in mind for self-review in the future.
Apologies, some of them I genuinely didn't know were mistakes, but a few I totally missed. Always trying to improve at this... |
There are still many unresolved conversations above. Could you either resolve them or note what's needed to resolve them? |
Done (I was looking at the file view so I missed those). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@domenic it would be great if you could do another pass as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a few nits
Instead of describing the callbacks one by one, put emphasis on how/when the caller expects responses (upon completion, chunk-by-chunk, fire-and-forget). This (hopefully) gives other specs who need to call into Fetch a quick reference between what they're trying to do and the API. Co-Authored-By: Domenic Denicola <d@domenic.me> Co-Authored-By: Anne van Kesteren <annevk@annevk.nl> Co-Authored-By: Jeffrey Yasskin <jyasskin@gmail.com>
Instead of describing the callbacks one by one, putting emphasis on how/when the caller expects responses (upon completion, chunk-by-chunk, fire-and-forget).
This (hopefully) gives other specs who need to call into Fetch a quick reference between what they're trying to do and the API.
(See WHATWG Working Mode: Changes for more details.)
Preview | Diff