Auto-populate Documentation Tab from Code | Voters

Auto-populate Documentation Tab from Code

Aubrey Taylor

Would love to be able to store task documentation in the task code itself. 
It's a common pattern, for example: Python does this with triple quoted strings at the file level. 
Maybe a {% docs %} {% enddocs %}
 tag at the top of the file. 
Just a thought. :)

May 10, 2023

Viktor

I'd add on top of that (please update the title to reflect expanded scope of the request if you feel like it's needed):
Add support for task file header comments similar to Tampermonkey/Stylus and many other.
For example Tampermonkey (and many others): https://stackoverflow.com/q/30399995
For example Stylus (and many others): https://github.com/openstyles/stylus/wiki/UserCSS/516f86a0c5d6fb74cc6796120af1edc5a6202a05
It's this kind of specially formatted header:
/* ==UserStyle==
@name        Example UserCSS style
@namespace   github.com/openstyles/stylus
@version     1.0.0
@license     unlicense
==/UserStyle== */
@-moz-document domain("example.com") {
a {
color: red;
}
}
What would be the use of this? It would allow for easy copy-pasta of the whole task code + name + triggers. It would allow storing everything in a human-readable format in a git repo (as opposed to the JSON task definitions that are currently being used and not human friendly)

Matt Sodomsky

Neat :)