Fix function comments based on best practices from Effective Go

jbrukh / bayesian

Naive Bayesian Classification for Golang.

Other

805 stars 128 forks source link

Fix function comments based on best practices from Effective Go #27

Closed BlakeMScurr closed 5 years ago

BlakeMScurr commented 5 years ago

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 commented 5 years ago

It looks like there's one fix up that updates the tense and reads well.

The rest basically just add colons to conform to standards like. Arguably they make readability worse. Let me know if you think they're valuable! :smile: