DOC: Extend description for delete to point that it could be URL etc #609
Conversation
Codecov Report
@@ Coverage Diff @@
## master #609 +/- ##
==========================================
+ Coverage 83.08% 84.66% +1.57%
==========================================
Files 59 59
Lines 5681 6109 +428
==========================================
+ Hits 4720 5172 +452
+ Misses 961 937 -24
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
dandi/cli/cmd_delete.py
Outdated
| @@ -10,7 +10,11 @@ | |||
| @devel_debug_option() | |||
| @map_to_click_exceptions | |||
| def delete(paths, skip_missing, dandi_instance="dandi", devel_debug=False): | |||
| """ Delete Dandisets and assets from the server """ | |||
| """Delete Dandisets and assets from the server | |||
There was a problem hiding this comment.
There needs to be a period at the end of this line to terminate the short description shown in dandi --help.
| """Delete Dandisets and assets from the server | ||
|
|
||
| PATH could be a local path or a URL to an asset, directory, or an entire | ||
| dandiset. |
There was a problem hiding this comment.
"Dandiset" should be capitalized, shouldn't it?
There was a problem hiding this comment.
For consistency with prior summary one -- sure... but it seems that we do not have consistency in general, but other commands use it lowercased. So I will make it lower cased here as well and it would look like
Usage: dandi [OPTIONS] COMMAND [ARGS]...
A client to support interactions with DANDI archive
(http://dandiarchive.org).
To see help for a specific command, run
dandi COMMAND --help
e.g. dandi upload --help
Options:
--version
-l, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
Log level (case insensitive). May be
specified as an integer. [default: INFO]
--pdb Fall into pdb if errors out
--help Show this message and exit.
Commands:
delete Delete dandisets and assets from the server.
digest Calculate file digests
download Download a file or entire folder from DANDI
ls List .nwb files and dandisets metadata.
organize (Re)organize files according to the metadata.
upload Upload dandiset (files) to DANDI archive.
validate Validate files for NWB (and DANDI) compliance.
yarikoptic
force-pushed
the
enh-doc-delete
branch
from
d41b09d to
2c498c4
Compare
|
I have addressed the comments, let's proceed. Thanks @jwodder for the review! |
isn't that right @jwodder ?