Skip to content

Commit a598718

Browse files
committed
Update new parameter docs and legacy default
1 parent b864138 commit a598718

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

bioblend/galaxy/workflows/__init__.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,14 @@ def show_workflow(
8282
:param version: Workflow version to show
8383
8484
:type instance: bool
85-
:param instance: this is a workflow ID and not a stored workflow ID
85+
:param instance: treat ``workflow_id`` as a Workflow ID if True,
86+
otherwise treat it as a StoredWorkflow ID (the default). This
87+
parameter works only on Galaxy 20.01 or later.
8688
8789
:type legacy: bool
88-
:param legacy: use the legacy workflow format
90+
:param legacy: whether to use the legacy workflow format (default is
91+
False). Before Galaxy 24.0, passing False to this parameter was
92+
mistakenly equivalent to passing True.
8993
9094
:rtype: dict
9195
:return: A description of the workflow and its inputs.
@@ -98,12 +102,12 @@ def show_workflow(
98102
"""
99103
params: dict[str, Any] = {}
100104

101-
if legacy is not None:
102-
params["legacy"] = legacy
103-
if instance is not None:
104-
params["instance"] = instance
105105
if version is not None:
106106
params["version"] = version
107+
if instance is not None:
108+
params["instance"] = instance
109+
if legacy is not None:
110+
params["legacy"] = legacy
107111

108112
return self._get(id=workflow_id, params=params)
109113

0 commit comments

Comments
 (0)