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 examples opts 4105 #4464

Merged
merged 4 commits into from Apr 30, 2020
Merged

Doc examples opts 4105 #4464

merged 4 commits into from Apr 30, 2020

Conversation

andycon
Copy link
Contributor

@andycon andycon commented Apr 29, 2020

DOC: examples: shortened opts for all code_cmds Closes #4105

This accompanies previous few commits..
Where I mostly just changed the obvious options:
--input -> -i
--output -> -o
--dataset -> -d
--recursive -> -r

maybe a few others (?)

the ones that I deemed non-obvious can be seen using
Something like that below

bash-3.2$ pwd
/Users/andy/Projects/datalad
bash-3.2$ pyfiles=`ls *py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$ pyfiles=`ls */*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$ pyfiles=`ls */*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
             code_cmd="datalad drop <path/to/content> --nocheck"),
             --source='https://github.com/datalad-datasets/longnow-podcasts.git'"""),
             datalad install --get-data \\
             code_cmd="datalad remove -d <path/to/dataset/> -r --nocheck"),
             code_cmd="datalad uninstall <path/to/subds> --nocheck"),
             code_cmd="datalad update --merge -s <siblingname>"),
             code_cmd="datalad update -s origin --merge "
             code_cmd="datalad rerun --since=HEAD~5"),
             code_cmd="datalad rerun --onto= --since=HEAD~5"),
                % datalad rerun --branch=verify --since=
             code_cmd="datalad run-procedure --discover"),
bash-3.2$ pyfiles=`ls */*/*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
            "datalad clone http://example.com/dataset --reckless shared-group"),
             code_cmd="datalad create --force"),
             code_cmd="datalad create --no-annex mydataset"),
             code_cmd="datalad diff --from <SHASUM>"),
             code_cmd="datalad diff --from branch1 --to branch2"),
             code_cmd="datalad save --version-tag 'bestyet'"),
             code_cmd="datalad status --annex")
cat: tools/testing/bad_internals/_scrapy:: No such file or directory
cat: scrapy.py: No such file or directory
bash-3.2$ pyfiles=`ls */*/*/*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$

andycon added 4 commits Apr 29, 2020
This accompanies previous few commits..
Where I mostly just changed the obvious options:
--inout -> -i
--output -> -o
--dataset -> -d
--recursive -> -r

the ones that I deemed non-obvious can be seen using
Something like that below

bash-3.2$ pwd
/Users/andy/Projects/datalad
bash-3.2$ pyfiles=`ls *py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$ pyfiles=`ls */*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$ pyfiles=`ls */*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
             code_cmd="datalad drop <path/to/content> --nocheck"),
             --source='https://github.com/datalad-datasets/longnow-podcasts.git'"""),
             datalad install --get-data \\
             code_cmd="datalad remove -d <path/to/dataset/> -r --nocheck"),
             code_cmd="datalad uninstall <path/to/subds> --nocheck"),
             code_cmd="datalad update --merge -s <siblingname>"),
             code_cmd="datalad update -s origin --merge "
             code_cmd="datalad rerun --since=HEAD~5"),
             code_cmd="datalad rerun --onto= --since=HEAD~5"),
                % datalad rerun --branch=verify --since=
             code_cmd="datalad run-procedure --discover"),
bash-3.2$ pyfiles=`ls */*/*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
            "datalad clone http://example.com/dataset --reckless shared-group"),
             code_cmd="datalad create --force"),
             code_cmd="datalad create --no-annex mydataset"),
             code_cmd="datalad diff --from <SHASUM>"),
             code_cmd="datalad diff --from branch1 --to branch2"),
             code_cmd="datalad save --version-tag 'bestyet'"),
             code_cmd="datalad status --annex")
cat: tools/testing/bad_internals/_scrapy:: No such file or directory
cat: scrapy.py: No such file or directory
bash-3.2$ pyfiles=`ls */*/*/*/*py`; for pf in $pyfiles; do  cat $pf | grep code_cmd -A 2 | grep " --"; done
bash-3.2$
@codecov
Copy link

codecov bot commented Apr 30, 2020

Codecov Report

Merging #4464 into master will increase coverage by 39.30%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #4464       +/-   ##
===========================================
+ Coverage   49.62%   88.92%   +39.30%     
===========================================
  Files         285      285               
  Lines       37844    37888       +44     
===========================================
+ Hits        18779    33692    +14913     
+ Misses      19065     4196    -14869     
Impacted Files Coverage Δ
datalad/core/local/diff.py 95.34% <ø> (+1.16%) ⬆️
datalad/core/local/run.py 98.70% <ø> (+34.05%) ⬆️
datalad/core/local/save.py 98.68% <ø> (+13.15%) ⬆️
datalad/core/local/status.py 98.09% <ø> (+14.28%) ⬆️
datalad/distribution/drop.py 98.79% <ø> (+14.45%) ⬆️
datalad/distribution/get.py 94.61% <ø> (+21.52%) ⬆️
datalad/distribution/install.py 98.87% <ø> (+30.33%) ⬆️
datalad/distribution/remove.py 90.62% <ø> (+58.59%) ⬆️
datalad/distribution/update.py 98.80% <ø> (+78.44%) ⬆️
datalad/core/local/tests/test_create.py 100.00% <0.00%> (+0.44%) ⬆️
... and 182 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 11932b3...4b22884. Read the comment docs.

mih
mih approved these changes Apr 30, 2020
Copy link
Member

@mih mih left a comment

Cool! Thank you!

Copy link
Member

@yarikoptic yarikoptic left a comment

Leaving honors for final decision/merge to @adswa ;-)

adswa
adswa approved these changes Apr 30, 2020
Copy link
Member

@adswa adswa left a comment

Thanks @andycon!

@adswa adswa merged commit 422bc59 into datalad:master Apr 30, 2020
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants