DOC: clarify description of the "install" interface to reflect its convoluted behavior#7445
Merged
Merged
Conversation
fff4919 to
cc614d8
Compare
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## maint #7445 +/- ##
==========================================
- Coverage 91.51% 91.34% -0.18%
==========================================
Files 325 325
Lines 43392 43390 -2
Branches 5819 0 -5819
==========================================
- Hits 39711 39635 -76
- Misses 3666 3755 +89
+ Partials 15 0 -15
☔ View full report in Codecov by Sentry. |
adswa
reviewed
Jun 30, 2023
Co-authored-by: Adina Wagner <adina.wagner@t-online.de>
Member
Author
|
we need a release with prior PR merged/resolving the issue. So I marked this for a candidate to kick out the release |
Member
Author
Collaborator
|
PR released in |
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
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.
Prompted by #7441 and might even close it if @asmacdo acdo agrees that it does.
I also changed "recommended" to "possible" in the paragraph about 'description' since I think we converged in some discussion in datalad-handbook that it is typically not recommended.
Now
--helpwould look likeUsage: datalad install [-h] [-s URL-OR-PATH] [-d DATASET] [-g] [-D DESCRIPTION] [-r] [-R LEVELS] [--reckless [auto|ephemeral|shared-...]] [-J NJOBS] [--branch BRANCH] [--version] [URL-OR-PATH ...] Install one or many datasets from remote URL(s) or local PATH source(s). This command creates local sibling(s) of existing dataset(s) from (remote) locations specified as URL(s) or path(s). Optional recursion into potential subdatasets, and download of all referenced data is supported. The new dataset(s) can be optionally registered in an existing superdataset by identifying it via the DATASET argument (the new dataset's path needs to be located within the superdataset for that). If no explicit -s|--source option is specified, then all positional URL-OR-PATH arguments are considered to be "sources" if they are URLs or target locations if they are paths. If a target location path corresponds to a submodule, the source location for it is figured out from its record in the `.gitmodules`. If -s|--source is specified, then a single optional positional PATH would be taken as the destination path for that dataset. It is possible to provide a brief description to label the dataset's nature *and* location, e.g. "Michael's music on black laptop". This helps ...