Decomplexify/document result-rendering switches #6174
Merged
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
The full story is in datalad#6038 Concretely, this: - documents the 'disabled' renderer mode - strip supported for the undocumented datalad.api.result-renderer config setting - homogeneous documentation for `--output-format` and `result_renderer` - rename `default[_result_renderer]` to `generic[_result_renderer` to resolve the multi-level ambiguity of "default" for a renderer that, ironically, is not the default. Shims for legacy code are in place, and will likely never be removed - replace internal usage of `output_format` with a consistent `result_renderer` for homogeneity. Command line API is kept unchanged though -- might be worth a follow-up discussion in a separate issue/PR Fixes datalad#6038
Which exploited a side-effect of the specific implementation. The intended, and now documented usage is result_renderer=`disabled`.
Codecov Report
@@ Coverage Diff @@
## master #6174 +/- ##
===========================================
- Coverage 89.70% 42.52% -47.18%
===========================================
Files 318 317 -1
Lines 41896 41617 -279
===========================================
- Hits 37584 17699 -19885
- Misses 4312 23918 +19606
Continue to review full report at Codecov.
|
|
This is ready. Will merge EOB today, unless objections are expressed. |
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.
The full story is in #6038
Concretely, this:
config setting
--output-formatandresult_rendererdefault[_result_renderer]togeneric[_result_renderertoresolve the multi-level ambiguity of "default" for a renderer that,
ironically, is not the default. Shims for legacy code are in place,
and will likely never be removed
output_formatwith a consistentresult_rendererfor homogeneity. Command line API is kept unchangedthough -- might be worth a follow-up discussion in a separate issue/PR
result_renderer=Noneand replacesit with
result_renderer='disabled'Fixes #6038