search

flashmob / go-guerrilla

Mini SMTP server written in golang
MIT License
2.78k stars 366 forks source link

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

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 are a couple of fix ups that update the tense and read well like this and [this](It looks like there are fix ups that update the tense and read well.

However, there are many changes that basically just add colons to conform to standards like this. Arguably they make readability worse. Let me know if you think they're valuable! :smile:

BlakeMScurr commented 5 years ago

outdated