diff --git a/dandi/cli/command.py b/dandi/cli/command.py index 209c210e8..02c93f5c4 100644 --- a/dandi/cli/command.py +++ b/dandi/cli/command.py @@ -70,7 +70,7 @@ def print_version(ctx, param, value): @click.option("--pdb", help="Fall into pdb if errors out", is_flag=True) @click.pass_context def main(ctx, log_level, pdb=False): - """A client to support interactions with a DANDI instance, such as the DANDI Archive (http://dandiarchive.org). + """A client to support interactions with DANDI instances, such as the DANDI Archive (http://dandiarchive.org). To see help for a specific command, run diff --git a/dandi/dandiapi.py b/dandi/dandiapi.py index f9bb4b10f..6e5142efa 100644 --- a/dandi/dandiapi.py +++ b/dandi/dandiapi.py @@ -889,7 +889,7 @@ def draft_version(self) -> Version: @property def api_path(self) -> str: """ - The path (relative to the base endpoint for a DANDI API) at + The path (relative to the base endpoint for the DANDI API) at which API requests for interacting with the Dandiset itself are made """ return f"/dandisets/{self.identifier}/" @@ -905,7 +905,7 @@ def api_url(self) -> str: @property def version_api_path(self) -> str: """ - The path (relative to the base endpoint for a DANDI instance API) at + The path (relative to the base endpoint for the DANDI API) at which API requests for interacting with the version in question of the Dandiset are made """ @@ -1429,7 +1429,7 @@ def from_base_data( @property def api_path(self) -> str: """ - The path (relative to the base endpoint for the DANDI instance API) at + The path (relative to the base endpoint for the DANDI API) at which API requests for interacting with the asset itself are made """ return f"/assets/{self.identifier}/" @@ -1639,7 +1639,7 @@ def digest_type(self) -> models.DigestType: """ .. versionadded:: 0.36.0 - The primary digest algorithm used by the DANDI instance for the asset, + The primary digest algorithm used by DANDI for the asset, determined based on its underlying data: dandi-etag for blob resources, dandi-zarr-checksum for Zarr resources """ @@ -1825,7 +1825,7 @@ def from_data( @property def api_path(self) -> str: """ - The path (relative to the base endpoint for a DANDI instance API) at + The path (relative to the base endpoint for the DANDI API) at which API requests for interacting with the asset itself are made """ return f"/dandisets/{self.dandiset_id}/versions/{self.version_id}/assets/{self.identifier}/" diff --git a/dandi/dandiarchive.py b/dandi/dandiarchive.py index 6a394b720..afffe4450 100644 --- a/dandi/dandiarchive.py +++ b/dandi/dandiarchive.py @@ -1,6 +1,6 @@ """ This module provides functionality for parsing URLs and other resource -identifiers for Dandisets & assets on DANDI instance servers and for fetching +identifiers for Dandisets & assets on DANDI instances and for fetching the objects to which the URLs refer. See :ref:`resource_ids` for a list of accepted URL formats. @@ -59,7 +59,7 @@ @dataclass class ParsedDandiURL(ABC): """ - Parsed representation of a URL pointing to a DANDI instance resource + Parsed representation of a URL pointing to a DANDI resource (Dandiset or asset(s)). Subclasses must implement `get_assets()`. Most methods take a ``client: DandiAPIClient`` argument, which must be a diff --git a/dandi/exceptions.py b/dandi/exceptions.py index 92e7ff160..01cd63c69 100644 --- a/dandi/exceptions.py +++ b/dandi/exceptions.py @@ -14,7 +14,7 @@ class OrganizeImpossibleError(ValueError): class UnknownURLError(ValueError): - """Given url is not known to correspond to DANDI Archive schema(s)""" + """Given url is not known to correspond to DANDI schema(s)""" pass diff --git a/docs/source/modref/dandiapi.rst b/docs/source/modref/dandiapi.rst index 529fd998a..8212711d0 100644 --- a/docs/source/modref/dandiapi.rst +++ b/docs/source/modref/dandiapi.rst @@ -3,7 +3,7 @@ ``dandi.dandiapi`` ================== -This module provides functionality for interacting with a DANDI instance server +This module provides functionality for interacting with a DANDI instance via the REST API. Interaction begins with the creation of a `DandiAPIClient` instance, which can be used to retrieve `RemoteDandiset` objects (representing Dandisets on the server) and `BaseRemoteAsset` objects (representing assets diff --git a/docs/source/modref/index.rst b/docs/source/modref/index.rst index 89572c7f7..373b48502 100644 --- a/docs/source/modref/index.rst +++ b/docs/source/modref/index.rst @@ -27,7 +27,7 @@ Such interfaces mirror :ref:`Command-Line Interfaces `. Mid-level user interfaces ========================== -These interfaces provide object-oriented interfaces to manipulate Dandisets and assets on a DANDI instance. +Object-oriented interfaces to manipulate Dandisets and assets on a DANDI instance. .. toctree:: @@ -36,7 +36,7 @@ These interfaces provide object-oriented interfaces to manipulate Dandisets and Low-level user interfaces ========================= -Low level interfaces to e.g. interact with the DANDI instance REST API and files directly. +Low level interfaces to e.g. interact with the DANDI REST API and files directly. .. toctree::