common-workflow-language / common-workflow-language/cwl-v1.2
Spec conflict?: `LoadListingRequirement` and `Directory.listing`
- Dominant language
- Common Workflow Language
- Stars
- 45
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
The spec of [`LoadListingEnum`](https://www.commonwl.org/v1.2/Workflow.html#LoadListingEnum) used in [`LoadListingRequirement`](https://www.commonwl.org/v1.2/Workflow.html#LoadListingRequirement) says:
> Specify the desired behavior for loading the `listing` field of a Directory object for use by expressions.
On the other hand, the spec of [`Directory`](https://www.commonwl.org/v1.2/Workflow.html#Directory) says that:
> If `listing` is not provided, the implementation must have some way of fetching the Directory listing at runtime based on the `location` field.
I am not sure I can say it a "conflict" but at least CWL v1.0, that has the same description of `listing`, implicitly requires the platforms loading the Directory listing recursively.
It would be nice if the section of `Directory` mentions `loadListing` and `LoadListingRequirement`.
Contributor guide
No contributing guide indexed for this repository
Research direction
Read the linked LoadListingEnum, LoadListingRequirement, and Directory sections in the CWL v1.2 specification, along with the issue discussion. Clarify whether their requirements conflict and update the Directory section to explain the relationship with loadListing and LoadListingRequirement; done means the specification is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100