Fix function comments based on best practices from Effective Go

rjeczalik / notify

File system event notification library on steroids.

MIT License

902 stars 128 forks source link

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

Closed CodeLingoBot closed 3 years ago

CodeLingoBot commented 5 years ago

Signed-off-by: CodeLingo Bot bot@codelingo.io

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

mullikine commented 5 years ago

I have triple checked this PR to make sure the bot has done its job of correctly fixing incorrect doc comments without introducing any false positives.

If this service is useful to you, please let me know :smile:

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

mullikine commented 5 years ago

I noticed that one of the travis-ci tests failed (TestStopPathNotExists, Go 1.11.x, macOS). Please let me know if it's an issue with this PR so I can touch it up. Cheers!