Conversation
|
|
||
| ## Hints registry repository | ||
|
|
||
| A new GitHub repository should be created under the `openwdl` organization for the purpose of maintaining the hint registry (if the concept of a registry would be useful for other WDL constructs such as `meta` or `parameter_meta`, perhaps it shouldn't be limited to hints). The README and pull request template of this repository would spell out the process of registering a new hint and provide examples of extending the CSV. Once a PR adding a hint is accepted, that's largely the end of the process. It's now included by reference in the specification. |
There was a problem hiding this comment.
if the concept of a registry would be useful for other WDL constructs such as
metaorparameter_meta, perhaps it shouldn't be limited to hints
this is an interesting idea. There are currently a variety of competing documentation schemas for the meta sections. I'm skeptical of codifying documentation conventions in the spec, but a registry may be an ideal middle-ground. At the very least, keeping a centralized source of information for "these are all the conventions currently implemented by tools" would be helpful (and maybe lead to some type of consensus across environments?)
There was a problem hiding this comment.
Yep! It's useful for folks to have a central reference for how these things are being used, even if it doesn't go all the way to specifying details or is ever intended to be implemented by other engines.
2 participants
Rendered