Fix function comments based on best practices from Effective Go

docker / libcompose

*Unmaintained/Deprecated* An experimental go library providing Compose-like functionality

https://godoc.org/github.com/docker/libcompose

Apache License 2.0

586 stars 191 forks source link

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

Open Daanikus opened 5 years ago

Daanikus 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.

Daanikus commented 5 years ago

I'm not a huge fan of the colon-ifying (so to speak) and I welcome any feedback as to how I could improve the logic for this. Thanks.