Closed MillironX closed 2 years ago
Add YAML-based self-documenting definitions above every process, workflow and function for future compilation into the Sphinx documentation.
Most languages have some form of self-documentation for generating documentation and showing in tooltips
Nextflow doesn't really have this feature, but it should be easy to implement as Nextflow is Groovy is Java, and C# is MS Java.
We could manually add all of this info to the Sphinx docs now, but that would be a maintainability nightmare, and very labor-intensive.
A YAML docstring proposal is written up at https://gist.github.com/MillironX/bd9606623b3ccfdfb72d77e2bd3dc213. Let's follow that and wait for tools to incorporate those docstrings into the Sphinx documentation.
Summary
Add YAML-based self-documenting definitions above every process, workflow and function for future compilation into the Sphinx documentation.
More Info
Context
Most languages have some form of self-documentation for generating documentation and showing in tooltips
Nextflow doesn't really have this feature, but it should be easy to implement as Nextflow is Groovy is Java, and C# is MS Java.
Alternatives
We could manually add all of this info to the Sphinx docs now, but that would be a maintainability nightmare, and very labor-intensive.
Possible implementation
A YAML docstring proposal is written up at https://gist.github.com/MillironX/bd9606623b3ccfdfb72d77e2bd3dc213. Let's follow that and wait for tools to incorporate those docstrings into the Sphinx documentation.