flaxandteal / dewret

DEclarative Workflow REndering Tool
Apache License 2.0
1 stars 0 forks source link

Clarify input behaviour #27

Closed philtweir closed 2 months ago

philtweir commented 3 months ago

What does this PR do?

The fundamental problem it solves is that, as per feedback, when a raw value is passed as an argument to a function, it should not simply be captured as a default value for that function call, but be turned into a global parameter. However, this behaviour does not make sense for raw (literal) variables inside tasks/nested tasks. In practice, this turned out to be quite a major change with a number of corner cases.

Consequently, this PR includes the following:

How to test?

Run through the documented workflows in the docs folder, and ensure they make sense with the input code.

Who can review?

@elleryames or @KamenDimitrov97

elleryames commented 2 months ago

The import of nested_task in workflows.md line 346 is not needed for the (shuffle) example.

elleryames commented 2 months ago

I understand that this PR introduces a new concept of subworkflows, and there is test for this feature in test_cwl.py. We should in addition document and give an example for this feature, perhaps in workflows.md.