gondola icon indicating copy to clipboard operation
gondola copied to clipboard

Fix function comments based on best practices from Effective Go

Open BlakeMScurr opened this issue 6 years ago • 2 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.

BlakeMScurr avatar Feb 19 '19 00:02 BlakeMScurr

Looks like most of these changes are good like this, this, and this.

But it looks like there was an issue where it added the brackets to the function name here. Clearly a bug, which I'm planning on working on today - is it currently blocking?

Let me know if you think this was useful If not, what fixes would get you to merge? Did I basically capture it?

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.

BlakeMScurr avatar Feb 19 '19 00:02 BlakeMScurr

Also, please let me know what I can do about CI!

BlakeMScurr avatar Feb 19 '19 01:02 BlakeMScurr