gsnova icon indicating copy to clipboard operation
gsnova copied to clipboard

Fix function comments based on best practices from Effective Go

Open BlakeMScurr 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.

BlakeMScurr avatar Feb 19 '19 01:02 BlakeMScurr

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

But it looks like there was an unexpected behaviour where it removed the brackets from the function name here. Is that OK? Was there any particular reason to have them?

BlakeMScurr avatar Feb 19 '19 01:02 BlakeMScurr