Fix function comments based on best practices from Effective Go

tobyhede / go-underscore

Helpfully Functional Go - A useful collection of Go utilities. Designed for programmer happiness.

Other

1.3k stars 61 forks source link

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

Closed CodeLingoBot closed 1 year 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 ({{funcName}}) being declared. From effective go.

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

Daanikus commented 5 years ago

Hi there! Dan 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.

Dan & the CodeLingo Team