📖 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 68.79% 68.82% +0.02%
==========================================
Files 100 100
Lines 7641 7641
==========================================
+ Hits 5257 5259 +2
+ Misses 1948 1947 -1
+ Partials 436 435 -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
2 times, most recently
from
94c502d to
91daf1f
Compare
|
The CRD diff is only the text. |
|
/approve |
openshift-ci
bot
added
the
approved
api/v1/clustercatalog_types.go
Outdated
| //+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.
api/v1/clustercatalog_types.go
Outdated
| // 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.
|
This needs to be rebased, and that will also fix the e2e issues. |
|
Heard. I am going to update this PR and refactor my downstream slash command for godocs formatting. Hopefully, I can get this completed before shutdown. This was a one-off bit of untracked work for me, and a handful of other things popped up that are more urgent. |
openshift-merge-robot
added
the
needs-rebase
michaelryanpeter
force-pushed
the
docs-simplify-cc-ce
branch
from
91daf1f to
c025f93
Compare
openshift-merge-robot
removed
the
needs-rebase
perdasilva
force-pushed
the
docs-simplify-cc-ce
branch
from
c025f93 to
7b384be
Compare
perdasilva
removed
the
approved
|
/approve |
openshift-ci
bot
added
the
approved
|
/override crd-diff/crd-diff |
|
@pedjak: /override requires failed status contexts, check run or a prowjob name to operate on.
Only the following failed contexts/checkruns were expected:
If you are trying to override a checkrun that has a space in it, you must put a double quote on the context. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
/override crd-diff |
|
@pedjak: Overrode contexts on behalf of pedjak: crd-diff DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pedjak, perdasilva, tmshort The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit aea576c
into
operator-framework:main
5 participants
Description
Helping @perdasilva by updating the docs strings for the API definitions.
🤞 I did this right :)
Reviewer Checklist