Improved Job docs #2035
Merged
Improved Job docs #2035
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
Contributor
elizarov
commented
May 19, 2020
elizarov
commented
- A more consistent prose in the Job interface documentation, gradually explaining concepts without repetition.
- Clear introduction and naming of "coroutine job" vs "completable job".
- Explanation of what is a "cancellation cause" of Job and how that relates to CancellationException.
- Added a note to all Job-derived interfaces that they are not safe for inheritance in 3rd party libraries.
- Consistently copied a note on thread-safety to all job-derived interfaces.
* A more consistent prose in the Job interface documentation, gradually explaining concepts without repetition. * Clear introduction and naming of "coroutine job" vs "completable job". * Explanation of what is a "cancellation cause" of Job and how that relates to CancellationException. * Added a note to all Job-derived interfaces that they are not safe for inheritance in 3rd party libraries. * Consistently copied a note on thread-safety to all job-derived interfaces.
qwwdfsad
approved these changes
May 19, 2020
recheej
pushed a commit
to recheej/kotlinx.coroutines
that referenced
this pull request
Dec 28, 2020
* A more consistent prose in the Job interface documentation, gradually explaining concepts without repetition. * Clear introduction and naming of "coroutine job" vs "completable job". * Explanation of what is a "cancellation cause" of Job and how that relates to CancellationException. * Added a note to all Job-derived interfaces that they are not safe for inheritance in 3rd party libraries. * Consistently copied a note on thread-safety to all job-derived interfaces.
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.