DOC: Emphasize PATH in parameter descriptions of create #4763

adswa · 2020-07-23T11:09:53Z

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

codecov · 2020-07-23T11:58:56Z

Codecov Report

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

@@           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

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]).

…ions of create

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.

adswa · 2020-07-23T18:18:04Z

whoops, sorry for not thinking about this 🤦

kyleam · 2020-07-23T20:50:08Z

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 approved these changes Jul 23, 2020

View reviewed changes

kyleam added the do not merge Not to be merged, will trigger WIP app "not passed" status label Jul 23, 2020

kyleam changed the base branch from master to maint July 23, 2020 13:59

adswa and others added 2 commits July 23, 2020 10:00

DOC: Emphasize consequences of (not) using PATH in parameter descript…

339d88f

…ions of create

DOC: create: Use destination-specific markup for more parameters

6bd7665

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 force-pushed the doc-create branch from e6a0234 to 6bd7665 Compare July 23, 2020 14:02

kyleam removed the do not merge Not to be merged, will trigger WIP app "not passed" status label Jul 23, 2020

kyleam merged commit 36dee99 into datalad:maint Jul 23, 2020

adswa deleted the doc-create branch December 18, 2020 07:31

yarikoptic added the documentation Documentation-related issue label Jun 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Emphasize PATH in parameter descriptions of create #4763

DOC: Emphasize PATH in parameter descriptions of create #4763

adswa commented Jul 23, 2020

codecov bot commented Jul 23, 2020 •

edited

Loading

kyleam left a comment

adswa commented Jul 23, 2020

kyleam commented Jul 23, 2020

DOC: Emphasize PATH in parameter descriptions of create #4763

DOC: Emphasize PATH in parameter descriptions of create #4763

Conversation

adswa commented Jul 23, 2020

codecov bot commented Jul 23, 2020 • edited Loading

Codecov Report

kyleam left a comment

Choose a reason for hiding this comment

adswa commented Jul 23, 2020

kyleam commented Jul 23, 2020

codecov bot commented Jul 23, 2020 •

edited

Loading