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

DOC: Refine --reckless docstring on usage and wording #6043

Merged
merged 4 commits into from Oct 9, 2021
Merged

DOC: Refine --reckless docstring on usage and wording #6043

merged 4 commits into from Oct 9, 2021

Conversation

adswa
Copy link
Member

@adswa adswa commented Oct 6, 2021

This is an attempt to fix #6039, in which a user's confusion over the
--reckless parameter could be traced to a lack of clarity
about the fact that this parameter is meant to be used at cloning.
Therefore, this change adds concrete examples and more refined wording
to the parameter docstring.
This change also removes a rather patronizing statement completely.

@adswa adswa added the semver-patch Increment the patch version when merged label Oct 6, 2021
@adswa adswa linked an issue Oct 6, 2021 that may be closed by this pull request
datalad/interface/common_opts.py Outdated Show resolved Hide resolved
datalad/interface/common_opts.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 6, 2021

Codecov Report

Merging #6043 (5509539) into maint (588c2c8) will decrease coverage by 2.36%.
The diff coverage is 58.18%.

❗ Current head 5509539 differs from pull request most recent head a39c7dc. Consider uploading reports for the commit a39c7dc to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##            maint    #6043      +/-   ##
==========================================
- Coverage   90.27%   87.91%   -2.37%     
==========================================
  Files         312      312              
  Lines       42157    42189      +32     
==========================================
- Hits        38058    37091     -967     
- Misses       4099     5098     +999     
Impacted Files Coverage Δ
datalad/config.py 96.70% <ø> (-0.01%) ⬇️
datalad/interface/common_opts.py 100.00% <ø> (ø)
datalad/customremotes/datalad.py 35.93% <12.50%> (-3.41%) ⬇️
datalad/cmdline/helpers.py 71.09% <14.28%> (-0.72%) ⬇️
datalad/__init__.py 81.21% <33.33%> (-5.38%) ⬇️
datalad/api.py 65.95% <33.33%> (-1.44%) ⬇️
datalad/customremotes/archives.py 62.71% <33.33%> (ø)
datalad/cmdline/main.py 74.57% <55.55%> (-1.74%) ⬇️
datalad/customremotes/base.py 83.26% <100.00%> (+0.13%) ⬆️
datalad/local/tests/test_subdataset.py 100.00% <100.00%> (ø)
... and 93 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 588c2c8...a39c7dc. Read the comment docs.

@yarikoptic
Copy link
Member

first I got confused with CI fails, but it is for "Branch" (not PR; and since PR is from a branch in this repo instead of a fork) so the base for this PR is a bit outdated (without fixes) maint.

@adswa
Copy link
Member Author

adswa commented Oct 6, 2021

first I got confused with CI fails, but it is for "Branch" (not PR; and since PR is from a branch in this repo instead of a fork) so the base for this PR is a bit outdated (without fixes) maint.

Will rebase, one second.

This is an attempt to fix #6039, in which a user's confusion over the
--reckless parameter could be traced to a lack of clarity
about the fact that this parameter is meant to be used at cloning.
Therefore, this change adds concrete examples and more refined wording
to the parameter docstring.
This change also removes a rather patronizing statement completely.
@mih
Copy link
Member

mih commented Oct 7, 2021

Test failures are an intermittent fluke for codecov submission. No actual test failures.

adswa and others added 2 commits October 7, 2021 12:56
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's see what the test will do. I left one more suggestion for an incremental improvement.

datalad/interface/common_opts.py Outdated Show resolved Hide resolved
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
@mih mih mentioned this pull request Oct 9, 2021
Copy link
Member

@mih mih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx!

@mih mih merged commit 4d2ca30 into maint Oct 9, 2021
@mih mih deleted the doc-6039 branch October 9, 2021 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-patch Increment the patch version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify get --reckless docstring, only affects subdataset clones
4 participants