Fix function comments based on best practices from Effective Go

awslabs / ecs-refarch-service-discovery

An EC2 Container Service Reference Architecture for providing Service Discovery to containers using CloudWatch Events, Lambda and Route 53 private hosted zones.

Apache License 2.0

445 stars 81 forks source link

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

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.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

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.