Nit: Fix function comments that don't start w func name

[DataDavD]

Refactor function comments for go doc.

Note: I got bored and did this since it kinda annoyed me when working on another PR, so feel free to ignore and close this PR if y'a want.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[reyreaud-l]

Thanks a lot for these changes, it's something we're looking at getting better at. Not all the comment are perfect but they'll get picked up by GoDoc and that's already a good first step. Thanks!

[reyreaud-l]

One thing before we can merge your work (We should have a bot asking for this but it didn't trigger ?) Do you accept our contribution agreement & guidelines ? See here https://github.com/weaviate/weaviate/blob/main/CONTRIBUTING.md#agreements.

Please explicitly state in this PR that you agree with it and we can merge your work :)

[antas-marcin]

@DataDavD Simply stating in comment "I agree with CLA" will enable us to merge your PR

[DataDavD]

Hey friends, sorry for the response. Happy to help in any form.

I agree with CLA

[DataDavD]

hey friends, sorry for the bump, just wondering if y'all saw the PR should be good now.

cheers

[DataDavD]

hey sorry, just bumping this.