API documentation for ExecutorInterface #137
Merged
+270
−225
Conversation
This file contains 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
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.
This changeset adds documentation for the
ExecutorInterfaceand marks its cancellation logic (#28) as required. Practically, this is only a documentation addition, but theoretically this could be considered a BC break for implementations of this interface that do not currently follow this API definition. These APIs are somewhat internal and it's very unlikely this will affect any consumers of this package.The changeset builds on top of #135, see only the last commit for changes in this PR. I will rebase this once #135 is in.
Builds on top of #135 and #136
Refs #128