search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
42 stars 67 forks source link

more about enums #155

Open mr-c opened 5 years ago

mr-c commented 5 years ago

https://www.commonwl.org/user_guide/19-custom-types/index.html has a single reference but Zero explanation

swzCuroverse commented 2 years ago

@mr-c, has this issues been resolved with the above? If so, can you close the ticket.

Thank @Fienne for suggesting this might be closed.

mr-c commented 2 years ago

Thanks for the ping.

https://www.commonwl.org/user_guide/topics/custom-types.html and https://www.commonwl.org/user_guide/topics/inputs.html have enum examples, but they don't explain how enums work, and how their values can end up on the command line.

https://www.commonwl.org/user_guide/faq.html#enum-inputs has an entry about enums, confusing not worded as a question.

It should be more specific, enums are used when there is a fixed list of acceptable strings, and can't be used for any other type (can't have an enum of acceptable integers in CWL v1.[0-2] for example)

I don't know what question this FAQ entry is trying to solve. An explanation of enums should be moved to a better place, like the inputs section