Fix function comments based on best practices from Effective Go

[BlakeMScurr]

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.

[BlakeMScurr]

Looks like most of these changes are good like this and this.

I should note, however, that it also does some basic formatting and capitalisation fix ups like this when it doesn't know how to add the function comment nicely, but it sees there are other issues. Do you feel that's out of scope, or useful? Is it blocking at all?

Let me know if you think this was useful 😄

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.