gopencils icon indicating copy to clipboard operation
gopencils copied to clipboard

Fix function comments based on best practices from Effective Go

Open Daanikus opened this issue 6 years ago • 1 comments

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 avatar Feb 18 '19 01:02 Daanikus

I'm not sold on the use of colons here. Happy to hear feedback on this strategy and how I could fix the automation logic. Thanks.

Daanikus avatar Feb 18 '19 01:02 Daanikus