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

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

Conversation

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

@Daanikus
Copy link
Author

Daanikus commented Feb 19, 2019

Looks like these changes, few as they are, are pretty solid. Let me know if you find this useful 😄 If not, are there any fixes I can do to make it useful?

Note: I've only updated functions that CodeLingo can rewrite nicely, but you can install it on GitHub to review your PRs automatically and find all issues.

@CLAassistant
Copy link

CLAassistant commented Feb 19, 2019

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

3 participants