Fix function comments based on best practices from Effective Go

nytlabs / hive

A platform for backing crowdsourcing websites, built in golang for elasticsearch

Apache License 2.0

362 stars 38 forks source link

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

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 read wells.

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

Cheers :smile:

BlakeMScurr commented 5 years ago

outdated