ST1020: allow comments to start with deprecation comment #1549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dominikh
reviewed
Jun 1, 2024
stylecheck/st1020/st1020.go
Outdated
| @@ -55,6 +58,10 @@ func run(pass *analysis.Pass) (interface{}, error) { | |||
| if !ast.IsExported(decl.Name.Name) { | |||
| return | |||
| } | |||
| if _, ok := depr.Objects[pass.TypesInfo.ObjectOf(decl.Name)]; ok && strings.HasPrefix(text, "Deprecated:") { | |||
There was a problem hiding this comment.
When would a comment have the right prefix but not be marked as deprecated by deprecated.Analyzer?
There was a problem hiding this comment.
I put that strings.HasPrefix in so that this:
// wrong comment yo. //@diag (`comment on exported function`)
//
// Deprecated: don't use.
func F6() {}
Still gets flagged, and it only skips if the Deprecated: ... comment is the only comment.
There was a problem hiding this comment.
I'm not confused about the strings.HasPrefix, but about the use of depr. Isn't the strings.HasPrefix call enough?
There was a problem hiding this comment.
Oh right. Yeah, I guess that is rather redundant and pointless; just seemed like the "proper way" to do it. I removed it.
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1378