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

Open
wants to merge 1 commit into
base: master
from

Conversation

@CodeLingoBot
Copy link

commented Feb 13, 2019

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.

PR generated by CodeLingo. Install here to drive Continuous Higher Standards.

Fix function comments based on best practices from Comment First Word…
… As Subject

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

This comment has been minimized.

Copy link

commented Feb 13, 2019

Hi go-martini team and martini contributers,

@BlakeMScurr from CodeLingo here. This PR is testing out a new service. I'd love to hear your feedback or answer your questions. We're keen to learn how we can best help dev teams without getting in your way.

@BlakeMScurr & the CodeLingo Team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.