Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
x/tools/internal/telemetry: poor package comment #36238
I know it's an internal package, but the package doc for internal/telemetry is poorly conceived:
It doesn't say what the package does. It claims that the package is "opinionated' (a passive-agressive way to say, we don't care what you think about the design) but gives no hint at what that opinion leads to. Avoid editorializing, just say what the package does. And it wouldn't hurt to say what "telemetry" is and what it's measuring, and for whom.
Thanks for making this improvement suggestion.
For reference, before the telemetry packages were moved out of
// Package telemetry provides the hooks and adapters to allow use of telemetry // throughout gopls. package telemetry
I suspect it's challenging to describe what package