Removing incorrect jQuery XHR example from $.when() docs. Adding documentation on the arguments passed to done/ fail callbacks. #545
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… on the arguments passed to a master-Deferred. ... in both the fail and done cases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale for removing the XHR example rather than correcting it is that an equivalent example is also provided at the end of the documentation, and I struggled to fit the example into the new form, which includes documentation on the values passed to the master-Deferred doneCallback, which was previously undocumented.
This would complete #262 (or otherwise make it redundant).
I've also taken the opportunity to change occurrences of
jQuery.when, to the recommended style guidelinejQuery.when()