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

documenting outputs in **parameter**_meta isn't clear #637

Open
a-frantz opened this issue Apr 15, 2024 · 0 comments
Open

documenting outputs in **parameter**_meta isn't clear #637

a-frantz opened this issue Apr 15, 2024 · 0 comments

Comments

@a-frantz
Copy link

a-frantz commented Apr 15, 2024

The current situation where both inputs and outputs are documented within the parameter_meta section can be confusing. I've been told this overloading can be traced back to this issue on the cromwell repo. I would like to see the addition of an output_meta section to the specification. It would function similarly to the current parameter_meta, except only declared outputs would be permitted within.

Since inputs and outputs share a namespace, it could also make sense to keep the current behavior of parameter_meta but rename it to something like declaration_meta. IMO having two separate sections, one for inputs and one for outputs is the cleaner solution which will lead to better documentation.

@a-frantz a-frantz changed the title documenting outputs in **parameter**_meta doesn't make sense documenting outputs in **parameter**_meta isn't clear Apr 15, 2024
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