Merge pull request #1439 from dandi/enh-indentation

Slight tune up to formatting of examples etc to harmonize appearance/make shorter
dandi · May 3, 2024 · 87a3744 · 87a3744
2 parents 260b4d7 + b477d41
commit 87a3744
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 26 deletions.
diff --git a/dandi/cli/cmd_download.py b/dandi/cli/cmd_download.py
@@ -12,24 +12,26 @@
 from ..utils import get_instance, joinurl
 
 _examples = """
-EXAMPLES:\n
-# Download only the dandiset.yaml\n
-dandi download --download dandiset.yaml DANDI:000027\n
+EXAMPLES:
 
-# Download only dandiset.yaml if there is a newer version\n
-dandi download https://identifiers.org/DANDI:000027 --existing refresh
-
-# Download only the assets\n
-dandi download --download assets DANDI:000027
-
-# Download all from a specific version\n
-dandi download DANDI:000027/0.210831.2033
-
-# Download a specific directory\n
-dandi download dandi://DANDI/000027@0.210831.2033/sub-RAT123/
-
-# Download a specific file\n
-dandi download dandi://DANDI/000027@0.210831.2033/sub-RAT123/sub-RAT123.nwb
+\b
+ - Download only the dandiset.yaml
+   dandi download --download dandiset.yaml DANDI:000027
+\b
+ - Download only dandiset.yaml if there is a newer version
+   dandi download https://identifiers.org/DANDI:000027 --existing refresh
+\b
+ - Download only the assets
+   dandi download --download assets DANDI:000027
+\b
+ - Download all from a specific version
+   dandi download DANDI:000027/0.210831.2033
+\b
+ - Download a specific directory
+   dandi download dandi://DANDI/000027@0.210831.2033/sub-RAT123/
+\b
+ - Download a specific file
+   dandi download dandi://DANDI/000027@0.210831.2033/sub-RAT123/sub-RAT123.nwb
 """
 
 
@@ -45,7 +47,6 @@
 \b
 {_dandi_url_parser.known_patterns}
 
-\b
 {_examples}
 
 """

diff --git a/dandi/dandiarchive.py b/dandi/dandiarchive.py
@@ -676,14 +676,14 @@ class _dandi_url_parser:
         ),
     ]
     resource_identifier_primer = """RESOURCE ID/URLS:\n
-    dandi commands accept URLs and URL-like identifiers called <resource
-    ids> in the following formats for identifying Dandisets, assets, and
-    asset collections.
-
-    Text in [brackets] is optional.  A server field is a base API or GUI URL
-    for a DANDI Archive instance.  If an optional ``version`` field is
-    omitted from a URL, the given Dandiset's most recent published version
-    will be used if it has one, and its draft version will be used otherwise.
+ dandi commands accept URLs and URL-like identifiers called <resource
+ ids> in the following formats for identifying Dandisets, assets, and
+ asset collections.
+
+ Text in [brackets] is optional.  A server field is a base API or GUI URL
+ for a DANDI Archive instance.  If an optional ``version`` field is
+ omitted from a URL, the given Dandiset's most recent published version
+ will be used if it has one, and its draft version will be used otherwise.
     """
     known_patterns = "Accepted resource identifier patterns:" + "\n - ".join(
         [""] + [display for _, _, display in known_urls]