Skip to content
This repository has been archived by the owner on May 9, 2021. It is now read-only.

Exported function/variable mark as deprecated should not require a comment #438

Closed
bogdandrutu opened this issue Mar 4, 2019 · 1 comment

Comments

@bogdandrutu
Copy link

var (
	// Deprecated: Use ClientSentBytes.
	ClientRequestBytes = stats.Int64(
		"opencensus.io/http/client/request_bytes",
		"HTTP request body size if set as ContentLength (uncompressed)",
		stats.UnitBytes)
)

When run golint it returns an error:
comment on exported var ClientRequestBytes should be of the form "ClientRequestBytes ..."

I expect that deprecated exported functions/variable comments to be valid only with a deprecation message like the one I had.

@bogdandrutu bogdandrutu changed the title Public functions mark as deprecated should not require a comment Exported function/variable mark as deprecated should not require a comment Mar 4, 2019
@mvdan
Copy link
Member

mvdan commented May 8, 2021

Thank you for submitting this issue! As per golang/go#38968, we are freezing and deprecating golint. There's no drop-in replacement to golint per se, but you should find that Staticcheck works well in encouraging good Go code, much like golint did in the past, since it also includes style checks. There's always gofmt and go vet too, of course.

If you would like to contribute further, I'd encourage you to engage Staticcheck's issue tracker or look at vet's open issues, as they are both actively maintained. If you have an idea that doesn't fit into either of those tools, you could look at other Go linters, or write your own - these days it's fairly straightforward with go/analysis.

To help avoid confusion, I'm closing all issues before we freeze the repository. If you have any feedback, you can leave a comment on the proposal thread where it was decided to deprecate golint - though note that the proposal has been accepted for nearly a year. Thanks!

@mvdan mvdan closed this as completed May 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants