Closed
Description
Filed here to collect opinions. Sometimes it is convenient to support API documentation in the form of annotations right within the code. Sometimes, actually, not.
I guess if we'll go with deployments to pkg.go.dev (in #121), we'll need documentation in some standard format and maybe we'll imposed to generate it from sources.
For me it is terra incornita now: need to investigate the topic and collect opinions from experienced Go developers.
If we'll go this way, I assume a considerable amount of work to actually write the annotations as part of this issue.