Documentation
¶
Overview ¶
Package help renders operator-facing documentation for the runtime knobs commons owns — log verbosity, log formatting, HTTP wire tracing, HAR capture and output formatting — as a clicky Textable, so every CLI built on commons can splice the same block into its --help instead of re-documenting the same properties (or, more often, not documenting them at all).
The package deliberately sits outside logger/ and http/: clicky imports commons/{logger,text,collections,context}, so rendering help from any of those packages would create an import cycle.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Help ¶
Help composes the selected topics into a single document. With no names every topic is included; names are matched with collections.MatchItems, so "http", "!har" and "log*" all select as expected. The result is an api.Text, which satisfies api.Textable — callers pick String(), ANSI(), Markdown() or HTML().
Source Files