Skip to content

Update GoDoc comments to be user readable #1143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tracked by #740
everettraven opened this issue Aug 19, 2024 · 0 comments · Fixed by #1158
Closed
Tracked by #740

Update GoDoc comments to be user readable #1143

everettraven opened this issue Aug 19, 2024 · 0 comments · Fixed by #1158
Assignees
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

Comments

@everettraven
Copy link
Contributor

everettraven commented Aug 19, 2024

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.

@everettraven everettraven added epic/v1-api good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Aug 19, 2024
@everettraven everettraven added the v1.0 Issues related to the initial stable release of OLMv1 label Aug 19, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@everettraven everettraven self-assigned this Aug 21, 2024
@everettraven everettraven moved this to Done in OLM v1 Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant