Skip to content
This repository was archived by the owner on Jun 9, 2020. It is now read-only.

Commit a001142

Browse files
committed
Improve documentation per feedback
1 parent f67983d commit a001142

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

cwlgen/commandlinetool.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ def __init__(self, tool_id=None, base_command=None, label=None, doc=None,
4545
inputs (:class:`cwlgen.CommandInputParameter` objects),
4646
outputs (:class:`cwlgen.CommandOutputParameter` objects),
4747
arguments (:class:`cwlgen.CommandLineBinding` objects),
48+
hints (any | :class:`cwlgen.Requirement` objects)
4849
and requirements (:class:`cwlgen.Requirement` objects)
4950
are stored in lists which are initialized empty.
5051
'''

cwlgen/common.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ def parse_type(param_type, requires_type=False):
7272

7373
def get_type_dict(param_type):
7474
"""
75-
Convets
75+
Generic method to the get dict for any of the valid param_type types,
76+
ie: CWLType | InputRecordSchema | InputEnumSchema | InputArraySchema | string
77+
| array<CWLType | InputRecordSchema | InputEnumSchema | InputArraySchema | string>
7678
:param param_type:
7779
:type param_type: CWLType | InputRecordSchema | InputEnumSchema | InputArraySchema | string |
7880
array<CWLType | InputRecordSchema | InputEnumSchema | InputArraySchema | string>

cwlgen/workflow.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ def __init__(self, workflow_id=None, label=None, doc=None, cwl_version='v1.0'):
8686
self.inputs = [] # list[InputParameter]
8787
self.outputs = [] # list[WorkflowOutputParameter]
8888
self.steps = [] # list[WorkflowStep]
89-
self.requirements = []
90-
self.hints = None
89+
self.requirements = [] # list[Requirement]
90+
self.hints = [] # list[Requirement]
9191
self._path = None
9292

9393
self.ignore_attributes = ["inputs", "outputs"]

0 commit comments

Comments
 (0)