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 #80

Closed
wants to merge 1 commit into from

Conversation

BlakeMScurr
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.

Signed-off-by: CodeLingo Bot <bot@codelingo.io>
@BlakeMScurr
Copy link
Author

These are clearly very minor changes, I hope they're somewhat worthwhile but I don't think they're really worth a maintainer's time!

My script is supposed add the function name to the start of the comment and it also does some basic formatting and capitalisation fix ups. If it can't add the function name smoothly it shouldn't make a change. But apparently if it sees grammar/formatting fixes but doesn't know how to add the function name smoothly it makes the grammar change anyway.

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