Skip to content

Commit 1e81774

Browse files
committed
renamed help_string to help
1 parent b5b95d3 commit 1e81774

25 files changed

+853
-881
lines changed

docs/components.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ Shell Command Tasks
8686
name="Input",
8787
fields=[
8888
( "in_file", File,
89-
{ "help_string": "input file ...",
89+
{ "help": "input file ...",
9090
"position": 1,
9191
"mandatory": True } ),
9292
( "out_file", str,
93-
{ "help_string": "name of output ...",
93+
{ "help": "name of output ...",
9494
"position": 2,
9595
"output_file_template":
9696
"{in_file}_br" } ),
9797
( "mask", bool,
98-
{ "help_string": "create binary mask",
98+
{ "help": "create binary mask",
9999
"argstr": "-m", } ) ],
100100
bases=(ShellDef,) )
101101

docs/input_spec.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ Let's start from the previous example:
1616
name="Input",
1717
fields=[
1818
( "in_file", File,
19-
{ "help_string": "input file ...",
19+
{ "help": "input file ...",
2020
"position": 1,
2121
"mandatory": True } ),
2222
( "out_file", str,
23-
{ "help_string": "name of output ...",
23+
{ "help": "name of output ...",
2424
"position": 2,
2525
"output_file_template":
2626
"{in_file}_br" } ),
2727
( "mask", bool,
28-
{ "help_string": "create binary mask",
28+
{ "help": "create binary mask",
2929
"argstr": "-m", } ) ],
3030
bases=(ShellDef,) )
3131
@@ -109,10 +109,10 @@ There are also special types provided by Pydra:
109109
Metadata
110110
--------
111111
112-
In the example we used multiple keys in the metadata dictionary including `help_string`,
112+
In the example we used multiple keys in the metadata dictionary including `help`,
113113
`position`, etc. In this section all allowed key will be described:
114114
115-
`help_string` (`str`, mandatory):
115+
`help` (`str`, mandatory):
116116
A short description of the input field.
117117
118118
`mandatory` (`bool`, default: `False`):

docs/output_spec.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ a customized `output_spec` can be used, e.g.:
2323
type=File,
2424
metadata={
2525
"output_file_template": "{inp1}",
26-
"help_string": "output file",
26+
"help": "output file",
2727
"requires": ["inp1", "inp2"]
2828
},
2929
),
@@ -58,7 +58,7 @@ Metadata
5858

5959
The metadata dictionary for `output_spec` can include:
6060

61-
`help_string` (`str`, mandatory):
61+
`help` (`str`, mandatory):
6262
A short description of the input field. The same as in `input_spec`.
6363

6464
`mandatory` (`bool`, default: `False`):

0 commit comments

Comments
 (0)