Fix function comments based on best practices from Effective Go

ant0ine / go-json-rest

A quick and easy way to setup a RESTful JSON API

https://ant0ine.github.io/go-json-rest/

MIT License

3.51k stars 381 forks source link

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

Closed CodeLingoBot closed 5 years ago

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

PR generated by CodeLingo. Install here to drive Continuous Higher Standards.

BlakeMScurr commented 5 years ago

Hi @ant0ine and go-json-rest contributers,

@BlakeMScurr from CodeLingo here. This PR is testing out a new service. I'd love to hear your feedback or answer your questions. We're keen to learn how we can best help dev teams without getting in your way.

@BlakeMScurr & the CodeLingo Team

BlakeMScurr commented 5 years ago

@ant0ine how valuable do you find these changes? You should pass golint now - is that worth much to you? How much better would it be if all the changes were like https://github.com/ant0ine/go-json-rest/pull/234/files#diff-541659943e3a6411fa01bdaa15aba143L53, rather than just adding a colon after the function name?

(ps. sorry about the weird commit message 😆 our automated outreach process is very much in alpha)

BlakeMScurr commented 5 years ago

@ant0ine sorry, looks like we made a repeat PR https://github.com/ant0ine/go-json-rest/pull/235. Closing this one!