Skip to content

Update GoDoc comments to be user readable #1143

@everettraven

Description

@everettraven

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:

  • What is the purpose of this field? What does it allow me to achieve?
  • How does this field interact with other fields or features?
  • What are the limitations of this field?
  • Is this field optional or required?
    • IF optional, what happens if the field is omitted?

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.

Metadata

Metadata

Assignees

Labels

epic/v1-apigood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.v1.0Issues related to the initial stable release of OLMv1

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions