Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
zoe-translates opened this issue Jun 26, 2023 · 1 comment

Comments

@zoe-translates
Copy link
Contributor

The `inputBinding` can appear either on the outer array parameter definition
or the inner array element definition, and these produce different behavior when
constructing the command line, as shown above.

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.

@mr-c
Copy link
Member

mr-c commented Jul 5, 2023

Thank you @zoe-translates ; I agree with your comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants