BF: drop: Adjust annex's "use --force" message to avoid confusion #5194
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
Calling `datalad drop` on a file that has too few copies will confusingly propagate a message from `git annex drop` suggesting to use --force, an option `datalad drop` does not have. Replace --force with --nocheck. The new message may still be confusing to Python callers of drop() because it suggests --nocheck rather than check=False, but that's not a problem unique to this spot and is preferable to reporting the completely wrong option. Fixes datalad#5135.
|
I don't mind and like UX improvements, but I feel like it is opening pandora's box even though if just a crack ;) |
Codecov Report
@@ Coverage Diff @@
## maint #5194 +/- ##
===========================================
+ Coverage 60.68% 89.90% +29.22%
===========================================
Files 126 294 +168
Lines 18916 40953 +22037
===========================================
+ Hits 11479 36820 +25341
+ Misses 7437 4133 -3304
Continue to review full report at Codecov.
|
|
Thank you! I like the change a lot. It makes the error message actually helpful. |
This was referenced Oct 26, 2021
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.
Calling
datalad dropon a file that has too few copies willconfusingly propagate a message from
git annex dropsuggesting touse --force, an option
datalad dropdoes not have. Replace --forcewith --nocheck.
The new message may still be confusing to Python callers of drop()
because it suggests --nocheck rather than check=False, but that's not
a problem unique to this spot and is preferable to reporting the
completely wrong option.
Fixes #5135.