Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rule exported add checkPublicInterface option to check documentation in public interface definition #1002

Open
comdiv opened this issue Jun 28, 2024 · 1 comment

Comments

@comdiv
Copy link
Contributor

comdiv commented Jun 28, 2024

For now this code is valid:

// Some - some interface
type Some interface {
     // Correct - should do all correct
     Correct()
     // not valid format of comment
     SemiCorrect()
     NonCorrect() // no documentation
}

suggest to add checkPublicInterface to exported rule to check documentation on interface method declaration,
so here SemiCorrect() has not valid comment, and NonCorrect() doesn't have it at all

comdiv added a commit to comdiv/revive that referenced this issue Jun 28, 2024
…ule - to check public interface method comments
comdiv added a commit to comdiv/revive that referenced this issue Jun 28, 2024
comdiv added a commit to comdiv/revive that referenced this issue Jun 28, 2024
comdiv added a commit to comdiv/revive that referenced this issue Jun 28, 2024
@chavacava
Copy link
Collaborator

Hi @comdiv, thank you for reporting the issue and opening a PR (I'll check it in the next days)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants