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

Documentation #953

Closed
tmharwood opened this issue Aug 2, 2024 · 0 comments
Closed

Documentation #953

tmharwood opened this issue Aug 2, 2024 · 0 comments

Comments

@tmharwood
Copy link

Is your feature request related to a problem? Please describe.

A lot of files and functions are missing documentation, which makes it a little difficult to understand what is going on within each file without digging through code.

Describe the solution you'd like
Documentation / docstrings would be helpful! If not for every function (there are a lot, this would be very time consuming) then at least it would help to have some sort of docstring in each file describing what the purpose of that file is. It'd help onboard newcomers to the project a little bit better.

Additional context
Go's best practices involve comments for all top-level exported names as well as unexported non-trivial function declarations

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