Fix function comments based on best practices from Effective Go

uber / ringpop-go

Scalable, fault-tolerant application-layer sharding for Go applications

http://www.uber.com

MIT License

835 stars 83 forks source link

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

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

Looks like these changes, few as they are, are pretty solid. Let me know if you find this useful :smile: If not, are there any fixes I can do to make it useful?

Note: I've only updated functions that CodeLingo can rewrite nicely, but you can install it on GitHub to review your PRs automatically and find all issues.

CLAassistant commented 5 years ago

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}