This PR updates the describe-package function so that it uses the @function tag to describe what to document.
I don't really like this - why not use @public to declare publicly documented functions?
But the fact is that docs.openfn.org uses the @function tag, and it's more important to be consistent than to match Joe's arbitrary goodness aesthetic.
Describe-package is still a mess and still needs fixing (my fault), but I've added a tiny CLI here to help test this stuff.
Lightning's doc panel isn't documenting the same entities as the main docsite - see https://github.com/OpenFn/lightning/issues/2019
This PR updates the describe-package function so that it uses the
@functiontag to describe what to document.I don't really like this - why not use
@publicto declare publicly documented functions?But the fact is that docs.openfn.org uses the
@functiontag, and it's more important to be consistent than to match Joe's arbitrary goodness aesthetic.Describe-package is still a mess and still needs fixing (my fault), but I've added a tiny CLI here to help test this stuff.