Skip to content

Commit a46bfec

Browse files
committed
Update docstring
1 parent 545fb99 commit a46bfec

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

fractal_tasks_core/__FRACTAL_MANIFEST__.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -593,15 +593,15 @@
593593
"additionalProperties": {
594594
"$ref": "#/definitions/NapariWorkflowsInput"
595595
},
596-
"description": "See examples above. TODO: Update after issue 404"
596+
"description": "A dictionary of ``NapariWorkflowsInput`` values."
597597
},
598598
"output_specs": {
599599
"title": "Output Specs",
600600
"type": "object",
601601
"additionalProperties": {
602602
"$ref": "#/definitions/NapariWorkflowsOutput"
603603
},
604-
"description": "See examples above. TODO: Update after issue 404"
604+
"description": "A dictionary of ``NapariWorkflowsOutput`` values."
605605
},
606606
"input_ROI_table": {
607607
"title": "Input Roi Table",
@@ -656,7 +656,7 @@
656656
},
657657
"NapariWorkflowsInput": {
658658
"title": "NapariWorkflowsInput",
659-
"description": "Model for a value of the ``input_specs`` argument in\n``napari_workflows_wrapper``.",
659+
"description": "A value of the ``input_specs`` argument in ``napari_workflows_wrapper``.",
660660
"type": "object",
661661
"properties": {
662662
"type": {
@@ -681,7 +681,7 @@
681681
},
682682
"NapariWorkflowsOutput": {
683683
"title": "NapariWorkflowsOutput",
684-
"description": "Model for a value of the ``output_specs`` argument in\n``napari_workflows_wrapper``.",
684+
"description": "A value of the ``output_specs`` argument in ``napari_workflows_wrapper``.",
685685
"type": "object",
686686
"properties": {
687687
"type": {

fractal_tasks_core/tasks/_input_models.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ def mutually_exclusive_channel_attributes(cls, v, values):
5050

5151
class NapariWorkflowsInput(BaseModel):
5252
"""
53-
Model for a value of the ``input_specs`` argument in
54-
``napari_workflows_wrapper``.
53+
A value of the ``input_specs`` argument in ``napari_workflows_wrapper``.
5554
"""
5655

5756
type: Literal["image", "label"]
@@ -77,8 +76,7 @@ def channel_is_present(cls, v, values):
7776

7877
class NapariWorkflowsOutput(BaseModel):
7978
"""
80-
Model for a value of the ``output_specs`` argument in
81-
``napari_workflows_wrapper``.
79+
A value of the ``output_specs`` argument in ``napari_workflows_wrapper``.
8280
"""
8381

8482
type: Literal["label", "dataframe"]

fractal_tasks_core/tasks/napari_workflows_wrapper.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ def napari_workflows_wrapper(
123123
(standard argument for Fractal tasks,
124124
managed by Fractal server)
125125
:param workflow_file: Absolute path to napari-workflows YAML file
126-
:param input_specs: See examples above. TODO: Update after issue 404
127-
:param output_specs: See examples above. TODO: Update after issue 404
126+
:param input_specs: A dictionary of ``NapariWorkflowsInput`` values.
127+
:param output_specs: A dictionary of ``NapariWorkflowsOutput`` values.
128128
:param input_ROI_table: Name of the ROI table over which the task loops
129129
to apply napari workflows.
130130
Example: "FOV_ROI_table" => loop over the field of

0 commit comments

Comments
 (0)