common-workflow-language / common-workflow-language/schema_salad

It is not clear the relationship between (section 4, 5, 6) and other sections

Open
#388 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
86
Forks
64
Avg merge
19h 24m
Merged PRs (30d)
19

Description

The spec describes three data types: [`SaladRecordSchema`](https://www.commonwl.org/v1.0/SchemaSalad.html#SaladRecordSchema), [`SaladEnumSchema`](https://www.commonwl.org/v1.0/SchemaSalad.html#SaladEnumSchema) and [`Documentation`](https://www.commonwl.org/v1.0/SchemaSalad.html#Documentation) in the section 4, 5 and 6, respectively.

However, they are not referred by other sections and therefore it is hard to understand the relationship between these data types and other sections.

I guess they are corresponding to `record definition object`, `enumerated type objects` and `documentation objects` in the [section 2.6](https://www.commonwl.org/v1.0/SchemaSalad.html#Document_schema).

If it is correct, it would be nice if there is a link to the corresponding section for each data type from the section 2.6.
If not, it would be nice if the spec clarifies the relationship between the data types and other sections.

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.