staticcheck: add documentation text to select checks #1663
+8
−1
Conversation
This file contains hidden or 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
This change adds the `Text` field to the `Doc` field of the SA1002 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA1012 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA1014 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA1020 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA2000 analyzer. This change also updates the format of the method reference in the `Title` string to be consistent with other parts of the staticcheck documentation and the Go community conventions. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA2003 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
This change adds the `Text` field to the `Doc` field of the SA4010 analyzer. Signed-off-by: Charlotte Brandhorst-Satzkorn <[email protected]>
dominikh
requested changes
Jul 24, 2025
| }, | ||
| Doc: &lint.RawDocumentation{ | ||
| Title: `Invalid format in \'time.Parse\'`, | ||
| Text: `\'time.Parse\' requires a layout string that uses Go's reference time: \'Mon Jan 2 15:04:05 MST 2006\' (Unix date format). The layout must represent this date and time exactly. See https://pkg.go.dev/time#pkg-constants for layout examples.`, |
There was a problem hiding this comment.
Please wrap documentation at ~80 characters, see for example SA1004.
There was a problem hiding this comment.
Use \" instead of \' to quote the reference time so we get quotes in CLI output.
| }, | ||
| Doc: &lint.RawDocumentation{ | ||
| Title: `The result of \'append\' will never be observed anywhere`, | ||
| Text: `Calls to \'append\' produce a new slice value that must be used. When the result of \'append\' is assigned to a variable that is never subsequently read, or is immediately overwritten, the append operation has no effect.`, |
There was a problem hiding this comment.
immediately overwritten
doesn't have to be immediate, just before it's read.
append operation has no effect
It may have an effect, but it usually won't be the desired one.
| }, | ||
| Doc: &lint.RawDocumentation{ | ||
| Title: `Deferred \'Lock\' right after locking, likely meant to defer \'Unlock\' instead`, | ||
| Text: `Deferring \'Lock\' immediately after locking will cause a deadlock. Use \'Unlock\' instead.`, |
There was a problem hiding this comment.
It doesn't necessarily cause a deadlock (and there are indeed possible false positives with this check if you write hard to follow code).
At the end of the day, this check just flags a probable typo, I'm not sure what we could document about that.
dominikh
reviewed
Jul 24, 2025
| }, | ||
| Doc: &lint.RawDocumentation{ | ||
| Title: `\'sync.WaitGroup.Add\' called inside the goroutine, leading to a race condition`, | ||
| Title: `\'sync.(*WaitGroup).Add\' called inside the goroutine, leading to a race condition`, |
There was a problem hiding this comment.
Wouldn't this be (*sync.WaitGroup).Add?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR introduces documentation text for the following checks:
It also updates the format of the method reference in the
Titlestring to be consistent with other parts of the staticcheck documentation and the Go community conventions for SA2000.