Merge pull request #228 from adswa/dhub-ex

DOC: Add example URLs to parameter docstring
datalad · Oct 9, 2023 · beabc88 · beabc88
2 parents fda4591 + 4e760e1
commit beabc88
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/datalad_container/containers_add.py b/datalad_container/containers_add.py
@@ -118,9 +118,10 @@ class ContainersAdd(Interface):
         url=Parameter(
             args=("-u", "--url"),
             doc="""A URL (or local path) to get the container image from. If
-            the URL scheme is one recognized by Singularity ('shub://' or
-            'docker://'), a command format string for Singularity-based
-            execution will be auto-configured when
+            the URL scheme is one recognized by Singularity (e.g.,
+            'shub://neurodebian/dcm2niix:latest' or
+            'docker://debian:stable-slim'), a command format string for
+            Singularity-based execution will be auto-configured when
             [CMD: --call-fmt CMD][PY: call_fmt PY] is not specified.
             For Docker-based container execution with the URL scheme 'dhub://',
             the rest of the URL will be interpreted as the argument to