#1002 - add "checkPublicInterface" option to "exported" rule to allow check documentation on public methods on public interfaces #1003
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
…onst [var-naming] handle private uppercased const
…ule - to check public interface method comments
denisvmedia
reviewed
Jul 2, 2024
|
Hi @comdiv. Are you still working in the PR? (some tests are not passing) |
ccoVeille
reviewed
Jul 13, 2024
ccoVeille
approved these changes
Jul 22, 2024
ccoVeille
approved these changes
Jul 23, 2024
|
@chavacava I'm ready to merge when you also approve. |
denisvmedia
reviewed
Jul 29, 2024
Comment on lines
+328
to
+329
| if iface, ok := v.Type.(*ast.InterfaceType); ok { | ||
| if ast.IsExported(v.Name.Name) { |
There was a problem hiding this comment.
I'd maybe change it to
Suggested change
| if iface, ok := v.Type.(*ast.InterfaceType); ok { | |
| if ast.IsExported(v.Name.Name) { | |
| if ast.IsExported(v.Name.Name) { | |
| if iface, ok := v.Type.(*ast.InterfaceType); ok { |
This is to avoid preliminary type assertions for non-exported symbols.
P.S. And if so, two outer ifs would be possible to join as a single if (if w.checkPublicInterface && ast.IsExported(v.Name.Name)).
denisvmedia
reviewed
Jul 29, 2024
Comment on lines
+32
to
+35
| flagStr, ok := flag.(string) | ||
| if !ok { | ||
| panic(fmt.Sprintf("Invalid argument for the %s rule: expecting a string, got %T", r.Name(), flag)) | ||
| } |
There was a problem hiding this comment.
nit: the switch/case below can work without this assertion (it can compare flag to case values directly).
denisvmedia
reviewed
Jul 29, 2024
|
|
||
| type somePrivate interface { | ||
| AllGood() | ||
| } |
There was a problem hiding this comment.
nit (add a new line)
Suggested change
| } | |
| } |
denisvmedia
approved these changes
Jul 29, 2024
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.
Feature implementation for #1002