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: Emphasize PATH in parameter descriptions of create #4763

Merged
merged 2 commits into from Jul 23, 2020

Conversation

adswa
Copy link
Member

@adswa adswa commented Jul 23, 2020

This applies the description improvements @kyleam and I discussed in #4754.
Fixes #4754.

@codecov
Copy link

codecov bot commented Jul 23, 2020

Codecov Report

Merging #4763 into maint will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            maint    #4763   +/-   ##
=======================================
  Coverage   89.59%   89.60%           
=======================================
  Files         288      288           
  Lines       40209    40209           
=======================================
+ Hits        36027    36030    +3     
+ Misses       4182     4179    -3     
Impacted Files Coverage Δ
datalad/core/local/create.py 94.44% <ø> (ø)
datalad/support/gitrepo.py 90.37% <0.00%> (-0.08%) ⬇️
datalad/support/tests/test_annexrepo.py 96.58% <0.00%> (+0.15%) ⬆️
datalad/support/tests/test_cookies.py 100.00% <0.00%> (+13.33%) ⬆️

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 2633d5e...6bd7665. Read the comment docs.

kyleam
kyleam approved these changes Jul 23, 2020
Copy link
Collaborator

@kyleam kyleam left a comment

Thanks.

Since this is a just a docstring tweak and has potential to clear up confusion, I'll rebase this to maint. I'll also add a commit on top that uses destination-specific markup for the parameters (e.g., [PY: ... PY]).

@kyleam kyleam added the do not merge Not to be merged, will trigger WIP app "not passed" status label Jul 23, 2020
@kyleam kyleam changed the base branch from master to maint Jul 23, 2020
adswa and others added 2 commits Jul 23, 2020
A few spots in create's docstring already use destination-specific for
markup like [PY:... PY].  Use it in a few more spots, including the
--datatset and PATH parameters added in the previous commit.
@kyleam kyleam removed the do not merge Not to be merged, will trigger WIP app "not passed" status label Jul 23, 2020
@adswa
Copy link
Member Author

adswa commented Jul 23, 2020

whoops, sorry for not thinking about this 🤦

@kyleam
Copy link
Collaborator

kyleam commented Jul 23, 2020

whoops, sorry for not thinking about this

No worries. I'd guess I'm probably to blame for a good number of spots that hard code the command-line representation.

Thanks again. Will merge.

@kyleam kyleam merged commit 36dee99 into datalad:maint Jul 23, 2020
4 checks passed
@adswa adswa deleted the doc-create branch Dec 18, 2020
@yarikoptic yarikoptic added the documentation Documentation-related issue label Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation-related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can't create subds and save it to superds from inside to be created subds
3 participants