Enable customization of Constraint descriptions, standardize access
#294
Conversation
This file contains hidden or 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
These replace `short_description()` and `long_description()`. IMHO properties are a better fit for the task. The prefix `input_` communicates better *what* is being described. For now the default implementation merely calls `short/long_description()`. Closes datalad#286
This is the main approach to tailor to self-description of a constraint to a non-standard, unforseen, or simply unsupported use case. It wraps any other constraint and provides the documentation it has been parameterized with, instead of the original ones. A full replacement. For tailoring wrapped constraints to a dataset-scope, a dedicated set of documentation overrides with the tailored constraint can be given in addition. Closes datalad#267
2 tasks
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.
See the individual commit descriptions for details
Closes #267
Closes #286