Fix function comments based on best practices from Effective Go

[CodeLingoBot]

Signed-off-by: CodeLingo Bot bot@codelingo.io

[mullikine]

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.

[mullikine]

I have triple checked this PR to make sure the bot has done its job of correctly fixing incorrect doc comments without introducing any false positives.

If this service is useful to you, please let me know 😄

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.

[AntoineAugusti]

Thanks!