Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: extend message for a NoDatasetArgumentFound in require_dataset #4285

Merged
merged 3 commits into from
Mar 13, 2020

Conversation

yarikoptic
Copy link
Member

@yarikoptic yarikoptic commented Mar 12, 2020

This exception is now (since 0.12) is frequently shown to users due to breakage
of behavior as discussed in #3759 .
As it is worded minimally, it provides no instructions to the users and just
brings frustration. This commit extends message to provide instructions on how
to mitigate the error they start to observe

This exception is now (since 0.12) is frequently shown to users due to breakage
of behavior as discussed in datalad#3759 .
As it is worded minimally, it provides no instructions to the users and just
brings frustration.  This commit extends message to provide instructions on how
to mitigate the error they start to observe
@yarikoptic yarikoptic added enhancement UX user experience labels Mar 12, 2020
@yarikoptic yarikoptic added this to the 0.12.3 milestone Mar 12, 2020
@codecov
Copy link

codecov bot commented Mar 12, 2020

Codecov Report

Merging #4285 into maint will decrease coverage by 0.05%.
The diff coverage is 96.42%.

Impacted file tree graph

@@            Coverage Diff             @@
##            maint    #4285      +/-   ##
==========================================
- Coverage   89.66%   89.61%   -0.06%     
==========================================
  Files         275      275              
  Lines       36857    36864       +7     
==========================================
- Hits        33048    33035      -13     
- Misses       3809     3829      +20     
Impacted Files Coverage Δ
datalad/metadata/search.py 83.37% <80.00%> (ø)
datalad/core/local/tests/test_diff.py 99.48% <100.00%> (ø)
datalad/core/local/tests/test_run.py 98.68% <100.00%> (ø)
datalad/core/local/tests/test_status.py 98.86% <100.00%> (ø)
datalad/distribution/dataset.py 95.86% <100.00%> (ø)
datalad/interface/download_url.py 97.89% <100.00%> (ø)
datalad/interface/run_procedure.py 90.68% <100.00%> (ø)
datalad/interface/tests/test_unlock.py 98.09% <100.00%> (ø)
datalad/metadata/tests/test_base.py 99.30% <100.00%> (ø)
datalad/metadata/tests/test_search.py 94.96% <100.00%> (ø)
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89030cb...1b7da0e. Read the comment docs.

Rational: Many commands do not require/use any paths, focus on the
dataset location instead.
@mih
Copy link
Member

mih commented Mar 13, 2020

Pushed to additionsto the original change. Cummulative effect is:

/tmp % datalad status
[ERROR  ] No dataset found at '/tmp'.  Specify a dataset to work with by providing its path via the `dataset` option, or change the current working directory to be in a dataset. [dataset.py:require_dataset:570] (NoDatasetFound) 

@adswa adswa self-requested a review March 13, 2020 07:44
@mih mih merged commit 4281360 into datalad:maint Mar 13, 2020
@yarikoptic yarikoptic deleted the enh-no-dataset-msg branch October 7, 2020 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement UX user experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants