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

Open
wants to merge 1 commit into
base: master
Choose a base branch
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>
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

Googlers can find more info about SignCLA and this PR by following this link.

@BlakeMScurr
Copy link
Author

@googlebot great I'll get onto that ASAP.

Regarding the PR, it looks like these changes, few as they are, are pretty solid. Let me know if you find this useful 😄

Note: I've only updated functions 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.

None yet

3 participants