A generator-runner developer guide #476
Closed
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
christian-monch
force-pushed
the
generator-runner-users-guide
branch
from
25268a4
to
d455d63
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #476 +/- ##
==========================================
+ Coverage 92.33% 92.37% +0.03%
==========================================
Files 125 125
Lines 9530 9530
Branches 1025 1025
==========================================
+ Hits 8800 8803 +3
+ Misses 708 705 -3
Partials 22 22 ☔ View full report in Codecov by Sentry. |
This commit adds code examples that illustrate how to use mainly the generator-based runner execution. It also adds a section on terminating and killing processes.
The example code for unified processing contained a bug (an additional for-statement). This commit fixes the issue.
This commit removes an explanation and code that makes use of functionality that is introduced in the run-context-manager branch. The run-context-manager branch will extend the document appropriately.
This commit adds a description of the `exception_on_error`-keyword argument. It also details the behavior that a non-None `timeout`-keyword argument will trigger.
This commit improves the runner developers handbook: - unify wording - improve description clarity - put every sentence on a single line - fix typos
christian-monch
changed the title
adswa
reviewed
Oct 20, 2023
adswa
reviewed
Oct 20, 2023
Co-authored-by: Adina Wagner <[email protected]>
This commit addresses comment datalad#476 (comment). It modifies the explanation to describe: a) what needs to be done, and b) what is done in provided generator-protocols That should help to comprehend what a user has to do, when implementing a new protocol.
This addresses the comment at datalad#476 (comment)
This commit contains only small changes, which do not change the content, but just fix errors.
|
If we follow through with #541, it would be suboptimal to include this documentation in datalad-next. I suggest to repost the PR against datalad-core. I believe that even if we stop using that runner implementation over here, it will continue to live for a long time in datalad-core. I think a document in the set of design docs (or next to it) would be best. |
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 PR adds a first version of a developer guide to the generator-runner.
TODO: