Fix function comments based on best practices from Effective Go#15
Open
BlakeMScurr wants to merge 1 commit intorainycape:masterfrom
CodeLingoBot:rewrite
Open
Fix function comments based on best practices from Effective Go#15BlakeMScurr wants to merge 1 commit intorainycape:masterfrom CodeLingoBot:rewrite
BlakeMScurr wants to merge 1 commit intorainycape:masterfrom
CodeLingoBot:rewrite
Conversation
Signed-off-by: CodeLingo Bot <bot@codelingo.io>
Author
|
Looks like most of these changes are good like this, this, and this. But it looks like there was an issue where it added the brackets to the function name here. Clearly a bug, which I'm planning on working on today - is it currently blocking? Let me know if you think this was useful If not, what fixes would get you to merge? Did I basically capture it? 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. |
Author
|
Also, please let me know what I can do about CI! |
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.
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.