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.

Sign up for GitHub

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

Jump to bottom

List in documentation the "high level" interfaces corresponding to CLI #1200

Merged
merged 4 commits into from
Feb 22, 2023
Merged

List in documentation the "high level" interfaces corresponding to CLI #1200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a6f2c5
Add rudimentary doctring to high level "delete" interface
yarikoptic Feb 2, 2023
87f92d7
RF(DOC): add High-level Python interfaces - procedures corresponding …
yarikoptic Feb 2, 2023
549127e
Fix numpy style describing paths to avoid using rest * as inline emph…
yarikoptic Feb 2, 2023
bab0de9
Minor improvements to wording
yarikoptic Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions dandi/delete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,11 @@ def delete(
force: bool = False,
skip_missing: bool = False,
) -> None:
"""Delete dandisets and assets from the server.

PATH could be a local path or a URL to an asset, directory, or an entire
dandiset.
"""
deleter = Deleter(skip_missing=skip_missing)
for p in paths:
if is_url(p):
Expand Down
6 changes: 3 additions & 3 deletions dandi/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def validate_bids(

Parameters
----------
paths : *str
paths : list(str)
Paths to validate.
schema_version : str, optional
BIDS schema version to use, this setting will override the version specified in the dataset.
Expand All @@ -46,7 +46,7 @@ def validate_bids(

Notes
-----
* Eventually this should be migrated to BIDS schema specified errors, see discussion here:
- Eventually this should be migrated to BIDS schema specified errors, see discussion here:
https://github.com/bids-standard/bids-specification/issues/1262
"""

Expand Down Expand Up @@ -155,7 +155,7 @@ def validate(

Parameters
----------
paths: *str
paths: list(str)
Could be individual (.nwb) files or a single dandiset path.

Yields
Expand Down
2 changes: 2 additions & 0 deletions docs/source/cmdline/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _chap_cmdline:

**********************
Command-Line Interface
**********************
Expand Down
22 changes: 21 additions & 1 deletion docs/source/modref/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,33 @@ Python API
High-level user interfaces
==========================

Such interfaces mirror :ref:`Command-Line Interfaces <chap_cmdline>`.

.. autosummary::
:toctree: generated

delete
download
move
organize
upload
validate

Mid-level user interfaces
==========================

These interfaces provide object-oriented interfaces to manipulate Dandisets and assets in the
archive.

.. toctree::

dandiarchive

Mid-level user interfaces
Low-level user interfaces
=========================

Low level interfaces to e.g. interact with archive REST API interfaces and files directly.

.. toctree::

dandiapi
Expand Down