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

Improve CLI documentation #851

Merged
merged 4 commits into from
Jan 5, 2022
Merged

Improve CLI documentation #851

merged 4 commits into from
Jan 5, 2022

Conversation

jwodder
Copy link
Member

@jwodder jwodder commented Dec 13, 2021

This PR expands the docs for the individual subcommands, adds a page documenting the root dandi command, and adds a single reference page listing the resource identifier patterns for other pages to link to.

@jwodder jwodder added the documentation Changes only affect the documentation label Dec 13, 2021
@codecov
Copy link

codecov bot commented Dec 13, 2021

Codecov Report

Merging #851 (26c8afe) into master (7ee9da3) will decrease coverage by 0.12%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #851      +/-   ##
==========================================
- Coverage   86.83%   86.70%   -0.13%     
==========================================
  Files          60       60              
  Lines        6237     6237              
==========================================
- Hits         5416     5408       -8     
- Misses        821      829       +8     
Flag Coverage Δ
unittests 86.70% <ø> (-0.13%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
dandi/cli/cmd_organize.py 76.87% <ø> (ø)
dandi/cli/cmd_upload.py 55.88% <ø> (ø)
dandi/dandiarchive.py 85.99% <ø> (-2.42%) ⬇️
dandi/download.py 82.44% <0.00%> (-0.54%) ⬇️
dandi/dandiapi.py 89.69% <0.00%> (-0.18%) ⬇️

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 7ee9da3...26c8afe. Read the comment docs.

@jwodder jwodder marked this pull request as ready for review December 13, 2021 21:07
dandi/cli/cmd_upload.py Outdated Show resolved Hide resolved
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
@yarikoptic yarikoptic merged commit 85a3b78 into master Jan 5, 2022
@yarikoptic yarikoptic deleted the more-cmd-docs branch January 5, 2022 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants