renamed help_string to help

nipype · Jan 1, 2025 · 1e81774 · 1e81774
1 parent b5b95d3
commit 1e81774
Show file tree

Hide file tree

Showing 25 changed files with 853 additions and 881 deletions.
diff --git a/docs/components.rst b/docs/components.rst
@@ -86,16 +86,16 @@ Shell Command Tasks
         name="Input",
         fields=[
         ( "in_file", File,
-          { "help_string": "input file ...",
+          { "help": "input file ...",
             "position": 1,
             "mandatory": True } ),
         ( "out_file", str,
-          { "help_string": "name of output ...",
+          { "help": "name of output ...",
             "position": 2,
             "output_file_template":
                               "{in_file}_br" } ),
         ( "mask", bool,
-          { "help_string": "create binary mask",
+          { "help": "create binary mask",
             "argstr": "-m", } ) ],
         bases=(ShellDef,) )
 

diff --git a/docs/input_spec.rst b/docs/input_spec.rst
@@ -16,16 +16,16 @@ Let's start from the previous example:
         name="Input",
         fields=[
         ( "in_file", File,
-          { "help_string": "input file ...",
+          { "help": "input file ...",
             "position": 1,
             "mandatory": True } ),
         ( "out_file", str,
-          { "help_string": "name of output ...",
+          { "help": "name of output ...",
             "position": 2,
             "output_file_template":
                               "{in_file}_br" } ),
         ( "mask", bool,
-          { "help_string": "create binary mask",
+          { "help": "create binary mask",
             "argstr": "-m", } ) ],
         bases=(ShellDef,) )
 
@@ -109,10 +109,10 @@ There are also special types provided by Pydra:
 Metadata
 --------
 
-In the example we used multiple keys in the metadata dictionary including `help_string`,
+In the example we used multiple keys in the metadata dictionary including `help`,
 `position`, etc. In this section all allowed key will be described:
 
-`help_string` (`str`, mandatory):
+`help` (`str`, mandatory):
    A short description of the input field.
 
 `mandatory` (`bool`, default: `False`):

diff --git a/docs/output_spec.rst b/docs/output_spec.rst
@@ -23,7 +23,7 @@ a customized `output_spec` can be used, e.g.:
                     type=File,
                     metadata={
                         "output_file_template": "{inp1}",
-                        "help_string": "output file",
+                        "help": "output file",
                         "requires": ["inp1", "inp2"]
                     },
                 ),
@@ -58,7 +58,7 @@ Metadata
 
 The metadata dictionary for `output_spec` can include:
 
-`help_string` (`str`, mandatory):
+`help` (`str`, mandatory):
    A short description of the input field. The same as in `input_spec`.
 
 `mandatory` (`bool`, default: `False`):