Fix function comments based on best practices from Effective Go

SimonWaldherr / golang-examples

Go(lang) examples - (explain the basics of #golang)

https://simonwaldherr.github.io/golang-examples/

MIT License

1.57k stars 453 forks source link

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

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

These changes look pretty solid except the capitalisation of "Will" on this one, which I've noted an am fixing.

Let me know what you think! :smile: