common-workflow-language / common-workflow-language/user_guide

In "Inputs" > "Array Inputs", there should be more emphasis on where `inputBinding` appears

Open
#400 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Common Workflow Language
Stars
42
Forks
65
PR merge metrics
No merged PRs in 30d

Description

https://github.com/common-workflow-language/user_guide/blob/499d120c2d16bd41e358ec03a8ed95832a18bff1/src/topics/inputs.md?plain=1#L178-L180

This bit wasn't very clear, because it didn't clarify where "as above" specifically referred to, and what sort of "different behavior[s]" were expected.

It's clear that the text meant to direct the user's attention to `filesB` in the `array-inputs.cwl` file, where comparison with the other two inputs should lead to an observation about `inputBinding` on array vs. array elements.

But for one thing, this wasn't made clear. The user should've been given direct instruction about where to look. The code block was a bit far up, and its content a bit complicated with multiple levels of nesting.

In addition, it was difficult to reach a conclusion about "the different effect of `inputBinding` on array vs. array elements" just by observation alone. `filesB` differs from the other two inputs not just by the presence of `inputBinding` for elements (even this may not be clear to a new user). So it would be useful to explain in words the difference of behaviors with or without `inputBinding` on elements.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.