go-json-rest icon indicating copy to clipboard operation
go-json-rest copied to clipboard

Published 20 hours ago • verified publisher icon ant0ine

Fix function comments based on best practices from Effective Go

Open CodeLingoBot opened this issue 6 years ago • 2 comments

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.

CodeLingoBot avatar Feb 13 '19 01:02 CodeLingoBot

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 avatar Feb 13 '19 02:02 BlakeMScurr

@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-541659943e3a6411fa01bdaa15aba143R53, rather than just adding a colon after the function name?

BlakeMScurr avatar Feb 13 '19 02:02 BlakeMScurr