From d3caefafa6937ec6b2bbe65ee4a79eca731c0a02 Mon Sep 17 00:00:00 2001 From: Jennings Zhang Date: Tue, 18 Oct 2022 14:46:47 -0400 Subject: [PATCH] Elaborate about parser contract --- chris_plugin/chris_plugin.py | 9 ++++++++- setup.py | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/chris_plugin/chris_plugin.py b/chris_plugin/chris_plugin.py index 6050014..3a4a621 100644 --- 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 index 4fd01ec..85c731b 100644 --- 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={