Fix function comments based on best practices from Effective Go

nathany / looper

Go autotesting tool with readline support.

BSD 2-Clause "Simplified" License

390 stars 40 forks source link

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

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

I'd say these fix ups update read well! Let me know what you think! Also, does HoundBot catch and fix these cases like CodeLingo can? :stuck_out_tongue:

BlakeMScurr commented 5 years ago

outdated