Improve help message for the --validation option in dandi upload
#1768
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1768 +/- ##
=======================================
Coverage 75.07% 75.07%
=======================================
Files 84 84
Lines 11910 11910
=======================================
Hits 8942 8942
Misses 2968 2968
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR improves the help message for the --validation option in the dandi upload command by clarifying what behavior is discouraged. The original message ambiguously stated "Use of this option is highly discouraged," while the updated message more clearly states "Not requiring validation is highly discouraged."
Key Changes
- Clarified the help message to indicate that not requiring validation (i.e., using non-default values like 'skip' or 'ignore') is what's discouraged, rather than implying that using the option itself is discouraged
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
candleindark
force-pushed
the
enh-help-msg
branch
from
3cf16ab to
be4638b
Compare
yarikoptic
left a comment
yarikoptic
left a comment
There was a problem hiding this comment.
minor tune up -- keep discouragement in place!
candleindark
force-pushed
the
enh-help-msg
branch
from
be4638b to
65f37d9
Compare
|
🚀 PR was released in |
This PR improves help message for the
--validationoption indandi upload.Reviewer notes:
The meaning of the choice to ignore validation is unclear. In fact, the choice is not used in the production code. I made an educated guess on the meaning of the choice in constructing the help message.