Improve description of spancheck linter

[alexandear]

Your feature request related to a problem? Please describe.

The description for the spancheck linter on the website seems excessively lengthy and weirdly formatted (see screenshots). This decreases readability.

Describe the solution you'd like.

Drop examples from the description:

Check for mistakes with OpenTelemetry trace spans.

Common mistakes with OTEL trace spans include forgetting to call End, forgetting to set an Error status, forgetting to record the Error

Describe alternatives you've considered.

N/A

Additional context.

No response

[ldez]

I think we will just keep "Check for mistakes with OpenTelemetry trace spans."

Cleary the use of go:embed by the linter to handle the doc is a bad idea.

• https://github.com/jjti/go-spancheck/blob/54ed04d36213ca489cb34dd30034de72d0649486/spancheck.go#L20-L21
• https://github.com/jjti/go-spancheck/blob/v0.4.3/doc.go

[jjti]

whoops! I got that approach from go/tools/analysis packages, eg: https://github.com/golang/tools/blob/6a0605d4e3d20a2ffb313ef9106199551317973d/go/analysis/passes/lostcancel/lostcancel.go#L26

Did not realize we'd display the whole thing in these docs, though