hcat icon indicating copy to clipboard operation
hcat copied to clipboard

Documention on template function library

Open eikenb opened this issue 4 years ago • 1 comments

With the majority of template library functions moving into hashicat, it would be good if the downstream applications had decent reference documentation to refer to. Currently the template functions have basic docs, but nothing compared to the more extensive docs as they current exist in consul-template.

I'd like to hit somewhere between the verbosity of the current consul-template docs and the brief hashicat docs. I thinking the standard gdoc format with examples should work as a good starting point.

eikenb avatar Nov 10 '21 22:11 eikenb

Also compare the current function godoc comments (in hashicat) to the consul-template basic description to look for improvements to the godoc comments.

eikenb avatar Nov 10 '21 22:11 eikenb