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

Document Functions Thoroughly: #65

Open
alkindivv opened this issue Feb 14, 2024 · 4 comments
Open

Document Functions Thoroughly: #65

alkindivv opened this issue Feb 14, 2024 · 4 comments

Comments

@alkindivv
Copy link

Add detailed comments to each function describing its purpose, parameters, return values, and potential side effects. This enhances readability and helps other developers understand how to interact with the interface.

@mushitori
Copy link

working on it

@mushitori
Copy link

i am new in this repo, could you please explain on which files do we need to add comments?
i would be happy to contribute

@mushitori
Copy link

okay i found some functions which i understand and trying to write comments about params and return type.

i just wanted to confirm you wanted to write comments in GoDoc-style or JavaDoc-style ?

@alkindivv @garrettparris @itsdevbear

@calbera
Copy link
Contributor

calbera commented May 14, 2024

@mushitori use go-doc style

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

3 participants