DOC: build_doc: Document eval_params/_params_ override behavior #4482
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
containers-run builds ContainersRun._params_ from Run._params_ to extend run's interface with container-specific parameters. In doing so, it (presumably unintentionally) populates ContainersRun._params_ with parameters from eval_params because build_doc() modifies Run._params_ in place. Having eval_param keys in ContainersRun._params_ doesn't currently cause any issues because build_doc() does a blanket update of _params_ with eval_params, but a proposed change to build_doc() in dataladgh-4480 shows how this can fail. Explicitly document this behavior to make it clear to callers that they can rely on it and to prevent future build_doc() tweakers from unknowingly changing it. Supersedes datalad/datalad-container#119.
Codecov Report
@@ Coverage Diff @@
## maint #4482 +/- ##
==========================================
+ Coverage 89.63% 89.68% +0.04%
==========================================
Files 275 275
Lines 37103 37103
==========================================
+ Hits 33259 33275 +16
+ Misses 3844 3828 -16
Continue to review full report at Codecov.
|
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.
Supersedes datalad/datalad-container#119.
This will likely create a conflict with whatever eventually lands from gh-4480, but assuming that those changes keep the behavior documented in this PR, the conflict resolution will be trivial.