📖 Updating docs strings for API go definitions #2359
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2359 +/- ##
==========================================
- Coverage 74.45% 74.42% -0.03%
==========================================
Files 93 93
Lines 7300 7300
==========================================
- Hits 5435 5433 -2
- Misses 1433 1434 +1
- Partials 432 433 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
michaelryanpeter
force-pushed
the
docs-simplify-cc-ce
branch
from
c783c59 to
94c502d
Compare
michaelryanpeter
force-pushed
the
docs-simplify-cc-ce
branch
from
94c502d to
91daf1f
Compare
|
The CRD diff is only the text. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tmshort The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
| //+kubebuilder:printcolumn:name=Age,type=date,JSONPath=`.metadata.creationTimestamp` | ||
|
|
||
| // ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. | ||
| // The ClusterCatalog resource makes File-Based Catalog (FBC) data available to your cluster. |
There was a problem hiding this comment.
We should follow the godoc format where the comment starts with name of the property/field as it was =/
I learned this recently in the ClusterExtensionRevision API doc
There was a problem hiding this comment.
Actually https://github.com/openshift/enhancements/blob/master/dev-guide/api-conventions.md#use-json-field-names-in-godoc recommends lowercase variant.
| // The spec field defines the desired state of the ClusterCatalog. | ||
| // The spec field is required. | ||
| // The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. |
There was a problem hiding this comment.
Since these docs will be converted into docs for the users with kubectl explain, we use the user face facing field name, i.e. lowercase (i.e. instead of // Spec we do // spec)
| // The spec field defines the desired state of the ClusterCatalog. | |
| // The spec field is required. | |
| // The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. | |
| // spec is a required field that defines the desired state of the ClusterCatalog. | |
| // The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. |
perdasilva
left a comment
perdasilva
left a comment
There was a problem hiding this comment.
It seems we should follow the godoc standard with the yaml field names (lowercase) by convention. I've left a couple of illustrative suggestions. If we make those slight adjustments, everything else should be ok, I think.
4 participants
Description
Helping @perdasilva by updating the docs strings for the API definitions.
🤞 I did this right :)
Reviewer Checklist