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

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

Open
tom-tan opened this issue Jun 27, 2023 · 0 comments
Open

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

tom-tan opened this issue Jun 27, 2023 · 0 comments

Comments

@tom-tan
Copy link
Member

tom-tan commented Jun 27, 2023

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.

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

1 participant