Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document BatchedCommand and BatchedAnnex #6203

Merged
merged 2 commits into from
Nov 17, 2021

Conversation

christian-monch
Copy link
Contributor

This PR adds design documentation for BatchedCommand and BatchedAnnex, as well as a very basic test for BatchedCommand. This PR is a fallout of my work on implementing BatchedCommand and BatchedAnnex with the new generator-based runner. Although this PR might be outdated in the next or a later release, I think it provides some value.

  • Add documentation for BatchedCommand and BatchedAnnex
  • Add a basic test

@christian-monch christian-monch added documentation Documentation-related issue tests Add or improve existing tests semver-documentation Changes only affect the documentation, no impact on version semver-tests Changes only affect tests, no impact on version and removed documentation Documentation-related issue tests Add or improve existing tests labels Nov 17, 2021
Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

God, yes! Thank you!

@codecov
Copy link

codecov bot commented Nov 17, 2021

Codecov Report

Merging #6203 (0b69e78) into master (02f6914) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #6203   +/-   ##
=======================================
  Coverage   89.71%   89.71%           
=======================================
  Files         319      319           
  Lines       41717    41727   +10     
=======================================
+ Hits        37426    37436   +10     
  Misses       4291     4291           
Impacted Files Coverage Δ
datalad/tests/test_cmd.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02f6914...0b69e78. Read the comment docs.

@mih
Copy link
Member

mih commented Nov 17, 2021

Maybe a little side-note that I got initially confused by the terminology. "command" is not the thing that is "batched" (as in batchedCommand). When the term "command" is used, it is one of the stdin items that are passed to the running command-batch-process. But I am not sure how to do this better. It is not an argument either.

@adswa adswa force-pushed the master branch 2 times, most recently from ef2d634 to 7631474 Compare November 17, 2021 18:17
@mih mih merged commit c197bd7 into datalad:master Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-documentation Changes only affect the documentation, no impact on version semver-tests Changes only affect tests, no impact on version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants