Document asyncTaskContextCancelled request error reason#2520
Merged
Conversation
Adds a doc comment explaining when this case is emitted, how it relates to `taskCancelled`, and confirms the `Error Code: 1005` mapping.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
RequestErrorReason.asyncTaskContextCancelledso it matches the documentation style of the surrounding cases (taskCancelled,livePhotoTaskCancelled,dataProviderCancelled).asyncretrieveImageoverloads inKingfisherManager, when the surroundingTaskis cancelled before aURLSessionTaskis attached — e.g. cache hits,ImageDataProviderloads, or pre-launch cancellations) and how it relates totaskCancelled.Error Code: 1005mapping that already exists inerrorCode.This is a follow-up to #2519, which highlighted that the case had no DocC comment.
Test plan
swift build