feat: Document Liquid template functions #35
Merged
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
maciaszczykm
deleted the
mjg/prod-2216-document-liquidtpl-template-functions
branch
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.
Adds functionality to generate docs for all registered Liquid filters.
Adds tests checking if all filters are documented and if docs are up-to-date.
In order to update docs run
make gen-docs. Once it will be merged I will add automation in the docs repository to pull these and show them at docs.plural.sh.Note that not all filter functions are documented at the moment. It is done manually. Scraping them could be tricky as most of the docs live in Markdown documentation of sprig library with some filters being documented directly in the code. Besides that there are also our own functions which we add on top of that.