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

All top-level, exported names should have doc comments, as should non-trivial unexported type or function declarations #496

Open
EmilGeorgiev opened this issue May 19, 2024 · 0 comments

Comments

@EmilGeorgiev
Copy link

The code is well-documented overall, but there are some exported methods lacking comments. It would be beneficial to review the code and add comments to these methods to align with Go best practices. Without comments, it can be difficult for clients using these exported types to understand how to use them effectively.

Same for the non-trivial unexported types or functions/methods

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

1 participant