Update GoDoc comments to be user readable #1143
Labels
epic/v1-api
good first issue
Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.
v1.0
Issues related to the initial stable release of OLMv1
Milestone
As outlined in the Write User Readable Documentation in the GoDoc subsection of the OpenShift API Conventions, each field should be sufficiently documented such that an end user can answer:
GoDoc should also follow the Go comment standards outlined in https://tip.golang.org/doc/comment
In the RFC for #740 there is a set of proposed GoDoc changes with the intention to reduce review churn on any PRs that resolve this issue. Depending on when this change is made, the changes proposed in the RFC may need to be modified to correctly reflect the current state of the world.
The text was updated successfully, but these errors were encountered: