Fix function comments based on best practices from Effective Go

david415 / HoneyBadger

Quantum Insert detector/recorder

GNU General Public License v3.0

305 stars 39 forks source link

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

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

Looks like these changes, few as they are, are pretty solid. Let me know if you find this useful :smile:

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.

david415 commented 5 years ago

i do not find this useful and it seems like spam for your shitty company. if you submit a PR with these kinds of changes for the entire source tree then i will merge it.