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

Fix function comments based on best practices from Effective Go #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

CodeLingoBot
Copy link

Signed-off-by: CodeLingo Bot [email protected]

@mullikine
Copy link

Every exported function in a program should have a doc comment. The first sentence should be a summary that starts with the name being declared.
From effective go.

I generated this with CodeLingo and I'm keen to get some feedback, but this is automated so feel free to close it and just say "opt out" to opt out of future CodeLingo outreach PRs.

@mullikine
Copy link

I have taken a look at the context above and below this change, particularly the function 'GetMonitorsNamed', and it appears that the bot has done the right thing in this situation and fixed the incorrect doc comment.

Let me know if you think this was useful 😄

Note: I've only updated function comments that I know CodeLingo can rewrite nicely, but you can install it from the GitHub marketplace to review your PRs automatically and find all issues.

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

Successfully merging this pull request may close these issues.

2 participants