Fix function comments based on best practices from Effective Go #235
Open
CodeLingoBot wants to merge 1 commit into
Open
Fix function comments based on best practices from Effective Go
#235CodeLingoBot wants to merge 1 commit into
CodeLingoBot wants to merge 1 commit into
Conversation
Signed-off-by: CodeLingo Bot <bot@codelingo.io>
|
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 |
|
@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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.