From 9adc165b4a538479872b378eb366c34cb69d40c4 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Wed, 3 Jan 2024 14:25:46 +0000 Subject: [PATCH] add docstrings --- dcm2niix/__init__.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/dcm2niix/__init__.py b/dcm2niix/__init__.py index 64ed432e..42b26c2d 100644 --- 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:]