Refactor comments to be on public interface functions instead of concrete implementation functions
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Currently, all function comments for existing functions are on the concrete implementation functions instead of the interfaces.
An example of an interface without comments: https://gitlab.com/gitlab-org/api/client-go/-/blob/main/access_requests.go?ref_type=heads#L27 An example of the concrete implementation with the comment: https://gitlab.com/gitlab-org/api/client-go/-/blob/main/access_requests.go?ref_type=heads#L74
This is inverted from how it should be, because when using the interface, this means devs won't have any comments on the interface functions to help guide them.
This issue will migrate the function comments from the concrete implementation functions to the interface functions instead to align to Go's best practices.
Implementation Details
- Remove (or replace) the comment on the concrete implementation. A new comment may be used on the concrete implementation at the developer's discretion, though it won't need to conform to the existing guidelines.
- Add the formatted comment on the interface function instead.
- This work should be completed in multiple smaller MRs to ensure the MRs are reviewable.