Skip to content

Commit e44c468

Browse files
committed
Update comments to use upper case, periods and fix some typos
On-behalf-of: SAP <[email protected]> Signed-off-by: Marvin Beckers <[email protected]>
1 parent 83b4315 commit e44c468

File tree

3 files changed

+23
-24
lines changed

3 files changed

+23
-24
lines changed

sdk/apis/apis/v1alpha2/types_apibinding_conversion.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ func Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding(in *APIBinding, out *api
8585
}
8686

8787
// Convert_v1alpha2_AcceptablePermissionClaims_To_v1alpha1_AcceptablePermissionClaims converts v1alpha2.AcceptablePermissionClaims
88-
// to v1alpha1.AcceptablePermissionClaims. This is not a loseless conversion, verbs and selectors are lost in this conversion.
89-
// For loseless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
88+
// to v1alpha1.AcceptablePermissionClaims. This is not a lossless conversion, verbs and selectors are lost in this conversion.
89+
// For lossless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
9090
func Convert_v1alpha2_AcceptablePermissionClaims_To_v1alpha1_AcceptablePermissionClaims(in []AcceptablePermissionClaim, s kubeconversion.Scope) (out []apisv1alpha1.AcceptablePermissionClaim, overhanging []AcceptablePermissionClaim, err error) {
9191
for _, apc := range in {
9292
if len(apc.PermissionClaim.Verbs) == 1 && apc.PermissionClaim.Verbs[0] == "*" && apc.Selector.MatchAll {
@@ -107,7 +107,7 @@ func Convert_v1alpha2_AcceptablePermissionClaims_To_v1alpha1_AcceptablePermissio
107107

108108
// Convert_v1alpha2_AcceptablePermissionClaim_To_v1alpha1_AcceptablePermissionClaim converts v1alpha2.AcceptablePermissionClaim
109109
// to v1alpha1.AcceptablePermissionClaim. This is not a lossless conversion, selectors are lost in this conversion.
110-
// For loseless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
110+
// For lossless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
111111
func Convert_v1alpha2_AcceptablePermissionClaim_To_v1alpha1_AcceptablePermissionClaim(in *AcceptablePermissionClaim, out *apisv1alpha1.AcceptablePermissionClaim, s kubeconversion.Scope) error {
112112
if err := Convert_v1alpha2_ScopedPermissionClaim_To_v1alpha1_PermissionClaim(&in.ScopedPermissionClaim, &out.PermissionClaim, s); err != nil {
113113
return err
@@ -117,7 +117,7 @@ func Convert_v1alpha2_AcceptablePermissionClaim_To_v1alpha1_AcceptablePermission
117117
}
118118

119119
// Convert_v1alpha2_ScopedPermissionClaim_To_v1alpha1_PermissionClaim converts v1alhpa2.ScopedPermissionClaim to v1alpha1.PermissionClaim.
120-
// This is not a lossless conversion, for loseless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
120+
// This is not a lossless conversion, for lossless conversion use Convert_v1alpha2_APIBinding_To_v1alpha1_APIBinding.
121121
func Convert_v1alpha2_ScopedPermissionClaim_To_v1alpha1_PermissionClaim(in *ScopedPermissionClaim, out *apisv1alpha1.PermissionClaim, s kubeconversion.Scope) error {
122122
if err := Convert_v1alpha2_PermissionClaim_To_v1alpha1_PermissionClaim(&in.PermissionClaim, out, s); err != nil {
123123
return err
@@ -138,7 +138,7 @@ func Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding(in *apisv1alpha1.APIBind
138138
return err
139139
}
140140

141-
// store v1alpha1 acceptable permission claims in annotation. this is necessary for a clean conversion of
141+
// Store v1alpha1 acceptable permission claims in annotation. This is necessary for a clean conversion of
142142
// ResourceSelector, which went away in v1alpha2.
143143
_, overhangingV1PC, err := Convert_v1alpha1_AcceptablePermissionClaims_To_v1alpha2_AcceptablePermissionClaims(in.Spec.PermissionClaims, s)
144144
if err != nil {
@@ -155,7 +155,7 @@ func Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding(in *apisv1alpha1.APIBind
155155
out.Annotations[PermissionClaimsV1Alpha1Annotation] = string(encoded)
156156
}
157157

158-
// store v1alpha2 permission claims in annotation. this is necessary for a clean conversion of
158+
// Store v1alpha2 permission claims in annotation. This is necessary for a clean conversion of
159159
// verbs and label selectors, which were not existing in v1alpha1.
160160
if overhangingAPC, ok := in.Annotations[AcceptablePermissionClaimsAnnotation]; ok {
161161
acceptablePermissionClaims := []AcceptablePermissionClaim{}
@@ -174,7 +174,7 @@ func Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding(in *apisv1alpha1.APIBind
174174

175175
delete(out.Annotations, AcceptablePermissionClaimsAnnotation)
176176

177-
// make tests for equality easier to write by turning []string into nil
177+
// Make tests for equality easier to write by turning []string into nil.
178178
if len(out.Annotations) == 0 {
179179
out.Annotations = nil
180180
}
@@ -196,7 +196,7 @@ func Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding(in *apisv1alpha1.APIBind
196196
}
197197

198198
// Convert_v1alpha1_AcceptablePermissionClaims_To_v1alpha2_AcceptablePermissionClaims converts []v1alpha1.AcceptablePermissionClaim
199-
// to []v1alpha2.AcceptablePermissionClaim. This is not a lossless conversion, for loseless conversion use
199+
// to []v1alpha2.AcceptablePermissionClaim. This is not a lossless conversion, for lossless conversion use
200200
// Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding.
201201
func Convert_v1alpha1_AcceptablePermissionClaims_To_v1alpha2_AcceptablePermissionClaims(in []apisv1alpha1.AcceptablePermissionClaim, s kubeconversion.Scope) (out []AcceptablePermissionClaim, overhanging []apisv1alpha1.AcceptablePermissionClaim, err error) {
202202
for _, pc := range in {
@@ -215,7 +215,7 @@ func Convert_v1alpha1_AcceptablePermissionClaims_To_v1alpha2_AcceptablePermissio
215215
}
216216

217217
// Convert_v1alpha1_AcceptablePermissionClaim_To_v1alpha2_AcceptablePermissionClaim converts v1alpha1.AcceptablePermissionClaim
218-
// to v1alpha2.AcceptablePermissionClaim. This is not a lossless conversion, for loseless conversion use
218+
// to v1alpha2.AcceptablePermissionClaim. This is not a lossless conversion, for lossless conversion use
219219
// Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding.
220220
func Convert_v1alpha1_AcceptablePermissionClaim_To_v1alpha2_AcceptablePermissionClaim(in *apisv1alpha1.AcceptablePermissionClaim, out *AcceptablePermissionClaim, s kubeconversion.Scope) error {
221221
if err := Convert_v1alpha1_PermissionClaim_To_v1alpha2_ScopedPermissionClaim(&in.PermissionClaim, &out.ScopedPermissionClaim, s); err != nil {
@@ -227,7 +227,7 @@ func Convert_v1alpha1_AcceptablePermissionClaim_To_v1alpha2_AcceptablePermission
227227
}
228228

229229
// Convert_v1alpha1_PermissionClaim_To_v1alpha2_ScopedPermissionClaim converts v1alpha1.PermissionClaim
230-
// to v1alpha2.PermissionClaim. This is not a lossless conversion, for loseless conversion use
230+
// to v1alpha2.PermissionClaim. This is not a lossless conversion, for lossless conversion use
231231
// Convert_v1alpha1_APIBinding_To_v1alpha2_APIBinding.
232232
func Convert_v1alpha1_PermissionClaim_To_v1alpha2_ScopedPermissionClaim(in *apisv1alpha1.PermissionClaim, out *ScopedPermissionClaim, s kubeconversion.Scope) error {
233233
if err := Convert_v1alpha1_PermissionClaim_To_v1alpha2_PermissionClaim(in, &out.PermissionClaim, s); err != nil {

sdk/apis/apis/v1alpha2/types_apibinding_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,7 @@ func TestAPIBindingPermissionClaimSelectorCELValidation(t *testing.T) {
199199
}
200200

201201
if got := len(errs); got != len(tc.wantErrs) {
202-
t.Errorf("'%s': expected %d errors, got %d", tc.name, len(tc.wantErrs), len(errs))
203-
return
202+
t.Fatalf("'%s': expected %d errors, got %d", tc.name, len(tc.wantErrs), len(errs))
204203
}
205204

206205
for i := range tc.wantErrs {

sdk/apis/apis/v1alpha2/types_apiexport_conversion.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ const (
3737
func Convert_v1alpha2_APIExport_To_v1alpha1_APIExport(in *APIExport, out *apisv1alpha1.APIExport, s kubeconversion.Scope) error {
3838
out.ObjectMeta = *in.ObjectMeta.DeepCopy()
3939

40-
// before converting the spec, figure out which ResourceSchemas could not be represented in v1alpha1 and
41-
// retain them via an annotation
40+
// Before converting the spec, figure out which ResourceSchemas could not be represented in v1alpha1 and
41+
// retain them via an annotation.
4242
_, overhangingRS := Convert_v1alpha2_ResourceSchemas_To_v1alpha1_LatestResourceSchemas(in.Spec)
4343
if len(overhangingRS) > 0 {
4444
encoded, err := json.Marshal(overhangingRS)
@@ -51,8 +51,8 @@ func Convert_v1alpha2_APIExport_To_v1alpha1_APIExport(in *APIExport, out *apisv1
5151
out.Annotations[ResourceSchemasAnnotation] = string(encoded)
5252
}
5353

54-
// before converting the spec, figure out which PermissionClaims could not be represented in v1alpha1 and
55-
// retain them via an annotation
54+
// Before converting the spec, figure out which PermissionClaims could not be represented in v1alpha1 and
55+
// retain them via an annotation.
5656
_, overhangingPC, err := Convert_v1alpha2_PermissionClaims_To_v1alpha1_PermissionClaims(in.Spec.PermissionClaims, s)
5757
if err != nil {
5858
return err
@@ -73,8 +73,8 @@ func Convert_v1alpha2_APIExport_To_v1alpha1_APIExport(in *APIExport, out *apisv1
7373
return err
7474
}
7575

76-
// if the object was converted from v1alpha1 to v1alpha2 to v1alpha1, retain All and ResourceSelector
77-
// fields in PermissionClaims by reading the original (v1alpha1) PermissionClaims from an annotation
76+
// If the object was converted from v1alpha1 to v1alpha2 to v1alpha1, retain All and ResourceSelector
77+
// fields in PermissionClaims by reading the original (v1alpha1) PermissionClaims from an annotation.
7878
if originalPermissionClaims, ok := in.Annotations[PermissionClaimsV1Alpha1Annotation]; ok {
7979
permissionClaims := []apisv1alpha1.PermissionClaim{}
8080
if err := json.Unmarshal([]byte(originalPermissionClaims), &permissionClaims); err != nil {
@@ -92,7 +92,7 @@ func Convert_v1alpha2_APIExport_To_v1alpha1_APIExport(in *APIExport, out *apisv1
9292

9393
delete(out.Annotations, PermissionClaimsV1Alpha1Annotation)
9494

95-
// make tests for equality easier to write by turning []string into nil
95+
// Make tests for equality easier to write by turning []string into nil.
9696
if len(out.Annotations) == 0 {
9797
out.Annotations = nil
9898
}
@@ -198,8 +198,8 @@ func Convert_v1alpha1_APIExport_To_v1alpha2_APIExport(in *apisv1alpha1.APIExport
198198
return err
199199
}
200200

201-
// store permission claims in annotation. this is necessary for a clean conversion of
202-
// field All and FieldSelector, which went away in v1alpha2.
201+
// Store permission claims in annotation. This is necessary for a clean conversion of
202+
// fields All and FieldSelector, which went away in v1alpha2.
203203
if len(in.Spec.PermissionClaims) > 0 {
204204
if out.Annotations == nil {
205205
out.Annotations = make(map[string]string)
@@ -227,7 +227,7 @@ func Convert_v1alpha1_APIExport_To_v1alpha2_APIExport(in *apisv1alpha1.APIExport
227227

228228
delete(out.Annotations, ResourceSchemasAnnotation)
229229

230-
// make tests for equality easier to write by turning []string into nil
230+
// Make tests for equality easier to write by turning []string into nil.
231231
if len(out.Annotations) == 0 {
232232
out.Annotations = nil
233233
}
@@ -255,7 +255,7 @@ func Convert_v1alpha1_APIExport_To_v1alpha2_APIExport(in *apisv1alpha1.APIExport
255255

256256
delete(out.Annotations, PermissionClaimsAnnotation)
257257

258-
// make tests for equality easier to write by turning []string into nil
258+
// Make tests for equality easier to write by turning []string into nil.
259259
if len(out.Annotations) == 0 {
260260
out.Annotations = nil
261261
}
@@ -344,7 +344,7 @@ func Convert_v1alpha1_LatestResourceSchema_To_v1alpha2_ResourceSchema(in []strin
344344
// and are converted after this function has completed, in Convert_v1alpha1_APIExport_To_v1alpha2_APIExport.
345345
if schemas := in; schemas != nil {
346346
for _, schema := range schemas {
347-
// parse strings like "v1.resource.group.org"
347+
// Parse strings like "v1.resource.group.org".
348348
parts := strings.Split(schema, ".")
349349
if len(parts) < 3 {
350350
return fmt.Errorf("invalid schema %q: must have at least 3 dot-separated segments", schema)

0 commit comments

Comments
 (0)