add docstrings

rordenlab · Jan 3, 2024 · 9adc165 · 9adc165
1 parent 1969b87
commit 9adc165
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/dcm2niix/__init__.py b/dcm2niix/__init__.py
@@ -20,6 +20,12 @@
 
 
 def main(args=None, **run_kwargs):
+    """
+    Arguments:
+      args: defaults to `sys.argv[1:]`.
+      **run_kwargs: passed to `subprocess.run`.
+    Returns: `subprocess.CompletedProcess` instance.
+    """
     if args is None:
         import sys
         args = sys.argv[1:]