describe-package: document anything with an @function tag #723
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Not sure I like this but it's consistent with the main docsite
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Lightning's doc panel isn't documenting the same entities as the main docsite - see OpenFn/lightning#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.