Fix function comments based on best practices from Effective Go

[CodeLingoBot]

Signed-off-by: CodeLingo Bot [email protected]

[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 looked over each of the changes made by the bot, and it appears to have fixed some very trivial issues in your function comments. One side effect of the current algorithm used by the tenet that generated this PR is that it removes parentheses from the inital word of a function comment if that word refers to the function name, in order to make the sentence flow a little better. If this doesn't seem right to you, please let me know so I can remove that logic for future users.

If the issue is too trivial, feel free to close and ignore this PR. Although your feedback is incredibly valuable to us.

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.