cwl-v1.2 icon indicating copy to clipboard operation
cwl-v1.2 copied to clipboard

Several terms are used in the different meanings: (input) `parameter`

Open tom-tan opened this issue 1 year ago • 0 comments

Related: common-workflow-language/common-workflow-language#775

Section 3.1 defines a term parameter as follows:

A parameter is a named symbolic input or output of process, with an associated datatype or schema. During execution, values are assigned to parameters to make the input object or output object used for concrete process invocation.

That is, in my understanding, a parameter is associated with the schema but a parameter itself does not include the schema.

However, some explanations and definitions in the spec cause conflicts with the above definition or cause confusions.

For example:

  • The explanation of inputs field in section 5 says:

    Input parameters include a schema for each parameter ...

    that conflicts with the above definition.

  • Section 2.1 defines input parameters but it causes confusion with the above definition.

    The fields of the input object are referred to as "input parameters".

    in which the term field is defined as a name/value pair in the object. Of course we can define parameter and input parameter in a different way but it is better to use the consistent definitions.

It would be nice if the spec uses the defined terms consistently.

tom-tan avatar Jun 27 '23 02:06 tom-tan