Skip to content

Commit 5a085c4

Browse files
authored
Merge pull request #411 from djarecka/doc/callable
[doc] adding callable to the user guide
2 parents b72989d + 60b354a commit 5a085c4

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/output_spec.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The metadata dictionary for `output_spec` can include:
6262
A short description of the input field. The same as in `input_spec`.
6363

6464
`output_file_template` (`str`):
65-
If provided, the field is treated also as an output field and it is added to the output spec.
65+
If provided the output file name (or list of file names) is created using the template.
6666
The template can use other fields, e.g. `{file1}`. The same as in `input_spec`.
6767

6868
`output_field_name` (`str`, used together with `output_file_template`)
@@ -79,3 +79,10 @@ The metadata dictionary for `output_spec` can include:
7979
The fields do not have to be a part of the `output_file_template` and
8080
if any field from the list is not provided in the input, a `NOTHING` is returned for the specific output.
8181
This has a different meaning than the `requires` form the `input_spec`.
82+
83+
`callable` (`function`):
84+
If provided the output file name (or list of file names) is created using the function.
85+
The function can take `field` (the specific output field will be passed to the function),
86+
`output_dir` (task `output_dir` wil be used), `stdout`, `stderr` (`stdout` and `stderr` of
87+
the task will be sent) `inputs` (entire `inputs` will be passed) or any input field name
88+
(a specific input field will be sent).

0 commit comments

Comments
 (0)