Elaborate about parser contract

FNNDSC · Oct 18, 2022 · d3caefa · d3caefa
1 parent edf9a6b
commit d3caefa
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/chris_plugin/chris_plugin.py b/chris_plugin/chris_plugin.py
@@ -152,7 +152,14 @@ def main(options, outputdir):
     Parameters
     ----------
     parser : argparse.ArgumentParser
-        argument parser
+        A parser defining the arguments of this *ChRIS* plugin.
+        The parser must only define arguments which satisfy the
+        [*ChRIS* plugin specification](https://github.com/FNNDSC/CHRIS_docs/blob/master/specs/ChRIS_Plugins.adoc#arguments).
+        It must not use any positional arguments nor subparsers.
+        Argument groups are not supported either, though it might
+        be in a future version.
+        [Issue #2](https://github.com/FNNDSC/chris_plugin/issues/2)
+
     plugin_type: str
         one of: 'fs', 'ds', 'ts'
     category: str

diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 
 setup(
     name="chris_plugin",
-    version="0.1.1",
+    version="0.1.1-1",
     packages=["chris_plugin"],
     url="https://github.com/FNNDSC/chris_plugin",
     project_urls={