Fix function comments based on best practices from Effective Go #442
Conversation
Signed-off-by: CodeLingo Bot <[email protected]>
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here (e.g. What to do if you already signed the CLAIndividual signers
Corporate signers
Googlers can find more info about SignCLA and this PR by following this link. |
|
@googlebot sweet I'll get onto that. Regarding the content, it looks like these changes, few as they are, are pretty solid. Let me know if you find this useful 😄 and let me know if CI fails and there's anything you want me to do! 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. |
| @@ -47,7 +47,7 @@ func (cpm *ConcurrentPrinterMap) Refresh(newPrinters []Printer) { | |||
| cpm.byGCPID = g | |||
| } | |||
|
|
|||
| // Get gets a printer, using the native name as key. | |||
| // GetByNativeName gets gets a printer, using the native name as key. | |||
There was a problem hiding this comment.
gets gets -> gets
| @@ -60,7 +60,7 @@ func (cpm *ConcurrentPrinterMap) GetByNativeName(name string) (Printer, bool) { | |||
| return Printer{}, false | |||
| } | |||
|
|
|||
| // Get gets a printer, using the GCP ID as key. | |||
| // GetByGCPID gets gets a printer, using the GCP ID as key. | |||
There was a problem hiding this comment.
gets gets -> gets
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.