search

madari / go-socket.io

A Socket.IO backend implementation written in Go
http://gopkgdoc.appspot.com/pkg/github.com/madari/go-socket.io
MIT License
412 stars 64 forks source link

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

Closed CodeLingoBot closed 5 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 glanced over each of these changes, and the bot appears to have correctly fixed each function comment with no false positives.

Let me know if this was useful to you :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.

madari commented 5 years ago

Thanks!