Skip to content
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

🌱 Fix godoc manually by simply replacing existing comments #11543

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tsuzu
Copy link
Contributor

@tsuzu tsuzu commented Dec 4, 2024

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
part of #11238
successor of #11273

/area docs

@k8s-ci-robot
Copy link
Contributor

@tsuzu: The label(s) area/docs cannot be applied, because the repository doesn't have them.

In response to this:

part of #11238

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

/area docs

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.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 4, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @tsuzu. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 4, 2024
@tsuzu tsuzu changed the title [WIP] Fix godoc manually by simply replacing existing comments [WIP] 🌱 Fix godoc manually by simply replacing existing comments Dec 4, 2024
@tsuzu
Copy link
Contributor Author

tsuzu commented Dec 4, 2024

/area documentation

@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation and removed do-not-merge/needs-area PR is missing an area label labels Dec 4, 2024
@tsuzu tsuzu force-pushed the fix-godoc-manually branch from 84ab8c1 to a7e8749 Compare December 18, 2024 05:27
@tsuzu tsuzu changed the title [WIP] 🌱 Fix godoc manually by simply replacing existing comments 🌱 Fix godoc manually by simply replacing existing comments Dec 18, 2024
@tsuzu tsuzu marked this pull request as ready for review December 18, 2024 05:30
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 18, 2024
@alexander-demicev
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 9, 2025
@sbueringer
Copy link
Member

cc @JoelSpeed

@JoelSpeed
Copy link
Contributor

LGTM

CRDs will now need to be regenerated to get the verify main to pass

Does this get us now to a point where all fields start with the serialized string?

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign fabriziopandini for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 15, 2025
@tsuzu
Copy link
Contributor Author

tsuzu commented Jan 15, 2025

Not yet.

#11238 (comment)
We have some left tasks, but I'm not sure we should fix all test files and missing comments.

Fix existing comments to start with serialized names

  • They're not straightforward to fix to start with serialized names: 15
/cluster-api/api/v1beta1/cluster_types.go:486:2: godoc prefix of Topology should be 'topology '
/cluster-api/api/v1beta1/clusterclass_types.go:299:2: godoc prefix of MaxUnhealthy should be 'maxUnhealthy '
/cluster-api/api/v1beta1/clusterclass_types.go:304:2: godoc prefix of UnhealthyRange should be 'unhealthyRange '
/cluster-api/api/v1beta1/machinehealthcheck_types.go:68:2: godoc prefix of MaxUnhealthy should be 'maxUnhealthy '
/cluster-api/api/v1beta1/machinehealthcheck_types.go:76:2: godoc prefix of UnhealthyRange should be 'unhealthyRange '
/cluster-api/api/v1beta1/machineset_types.go:307:2: godoc prefix of FailureReason should be 'failureReason '
/cluster-api/api/v1beta1/machineset_types.go:330:2: godoc prefix of FailureMessage should be 'failureMessage '
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:43:2: godoc prefix of MaxUnhealthy should be 'maxUnhealthy '
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:48:2: godoc prefix of NodeStartupTimeout should be 'nodeStartupTimeout '
/cluster-api/internal/apis/core/v1alpha3/machineset_types.go:138:2: godoc prefix of FailureReason should be 'failureReason '
/cluster-api/internal/apis/core/v1alpha4/cluster_types.go:64:2: godoc prefix of Topology should be 'topology '
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:43:2: godoc prefix of MaxUnhealthy should be 'maxUnhealthy '
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:48:2: godoc prefix of UnhealthyRange should be 'unhealthyRange '
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:57:2: godoc prefix of NodeStartupTimeout should be 'nodeStartupTimeout '
/cluster-api/internal/apis/core/v1alpha4/machineset_types.go:145:2: godoc prefix of FailureReason should be 'failureReason '

Add missing comments

  • spec/status/items: 139
/cluster-api/api/v1beta1/cluster_types.go:1039:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/api/v1beta1/cluster_types.go:1040:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/cluster_types.go:1170:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/api/v1beta1/clusterclass_types.go:78:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/api/v1beta1/clusterclass_types.go:79:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/clusterclass_types.go:1074:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/api/v1beta1/machine_types.go:669:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/api/v1beta1/machine_types.go:670:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/machine_types.go:705:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/api/v1beta1/machinedeployment_types.go:558:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/api/v1beta1/machinedeployment_types.go:559:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/machinedeployment_types.go:568:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/api/v1beta1/machinehealthcheck_types.go:125:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/machinehealthcheck_types.go:239:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/api/v1beta1/machineset_types.go:410:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/api/v1beta1/machineset_types.go:411:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/api/v1beta1/machineset_types.go:446:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/api/v1beta1/machinepool_types.go:265:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/api/v1beta1/machinepool_types.go:266:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/exp/api/v1beta1/machinepool_types.go:301:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go:480:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go:481:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfig_types.go:516:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go:37:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go:50:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go:59:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/runtime/api/v1alpha1/extensionconfig_types.go:196:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go:410:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go:411:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadm_control_plane_types.go:446:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go:41:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go:50:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go:64:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/addons/api/v1beta1/clusterresourceset_types.go:181:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/addons/api/v1beta1/clusterresourceset_types.go:182:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/exp/addons/api/v1beta1/clusterresourceset_types.go:191:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go:178:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/addons/api/v1beta1/clusterresourcesetbinding_types.go:203:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/ipam/api/v1beta1/ipaddress_types.go:56:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/ipam/api/v1beta1/ipaddress_types.go:65:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/ipam/api/v1beta1/ipaddressclaim_types.go:60:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/ipam/api/v1beta1/ipaddressclaim_types.go:61:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/exp/ipam/api/v1beta1/ipaddressclaim_types.go:80:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha3/cluster_types.go:214:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha3/cluster_types.go:215:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha3/cluster_types.go:234:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machine_types.go:256:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machine_types.go:257:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machine_types.go:278:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinedeployment_types.go:262:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinedeployment_types.go:263:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinedeployment_types.go:274:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:75:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:157:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machineset_types.go:204:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machineset_types.go:205:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machineset_types.go:216:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go:126:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go:127:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha3/clusterresourceset_types.go:138:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go:115:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha3/clusterresourcesetbinding_types.go:136:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/cluster_types.go:293:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha4/cluster_types.go:294:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha4/cluster_types.go:399:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/clusterclass_types.go:37:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha4/clusterclass_types.go:133:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machine_types.go:255:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machine_types.go:256:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machine_types.go:277:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinedeployment_types.go:293:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinedeployment_types.go:294:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinedeployment_types.go:305:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:86:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:170:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machineset_types.go:216:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machineset_types.go:217:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machineset_types.go:228:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go:128:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go:129:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha4/clusterresourceset_types.go:140:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go:116:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/addons/v1alpha4/clusterresourcesetbinding_types.go:137:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha3/machinepool_types.go:224:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha3/machinepool_types.go:225:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha3/machinepool_types.go:246:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha4/machinepool_types.go:220:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha4/machinepool_types.go:221:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/core/exp/v1alpha4/machinepool_types.go:242:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go:147:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go:148:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfig_types.go:169:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go:30:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go:45:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go:56:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go:140:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go:141:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfig_types.go:162:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go:30:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go:46:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go:57:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/api/v1alpha3/provider_type.go:169:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/bootstrap/generic_types.go:33:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/bootstrap/generic_types.go:41:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/bootstrap/generic_types.go:56:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/controlplane/generic_types.go:40:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/controlplane/generic_types.go:49:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/external/generic_types.go:36:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/external/generic_types.go:52:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/infrastructure/generic_types.go:35:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/infrastructure/generic_types.go:50:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/infrastructure/generic_types.go:65:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/infrastructure/generic_types.go:80:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:57:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:68:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:69:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:102:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:113:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:114:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:176:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:187:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:188:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:260:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:271:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:272:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go:207:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go:208:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha3/kubeadm_control_plane_types.go:229:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go:222:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go:223:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadm_control_plane_types.go:244:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go:41:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go:52:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go:61:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/ipam/api/v1alpha1/ipaddress_types.go:55:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/ipam/api/v1alpha1/ipaddress_types.go:64:2: godoc prefix of Items should be 'items ' (missing)
/cluster-api/exp/ipam/api/v1alpha1/ipaddressclaim_types.go:55:2: godoc prefix of Spec should be 'spec ' (missing)
/cluster-api/exp/ipam/api/v1alpha1/ipaddressclaim_types.go:56:2: godoc prefix of Status should be 'status ' (missing)
/cluster-api/exp/ipam/api/v1alpha1/ipaddressclaim_types.go:75:2: godoc prefix of Items should be 'items ' (missing)
  • In test files
/cluster-api/cmd/clusterctl/internal/test/providers/bootstrap/generic_types.go:24:2: godoc prefix of DataSecretName should be 'dataSecretName ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/controlplane/generic_types.go:26:2: godoc prefix of InfrastructureRef should be 'infrastructureRef ' (missing)
/cluster-api/cmd/clusterctl/internal/test/providers/controlplane/generic_types.go:31:2: godoc prefix of MachineTemplate should be 'machineTemplate ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:74:2: godoc prefix of Foo should be 'foo ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:80:2: godoc prefix of Bar should be 'bar ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:83:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:119:2: godoc prefix of Foo should be 'foo ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:125:2: godoc prefix of Bar should be 'bar ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:128:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:131:2: godoc prefix of V1Beta2 should be 'v1beta2 ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:138:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:193:2: godoc prefix of Foo should be 'foo ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:199:2: godoc prefix of Bar should be 'bar ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:202:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:208:2: godoc prefix of Deprecated should be 'deprecated ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:215:2: godoc prefix of V1Beta1 should be 'v1beta1 ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:222:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:277:2: godoc prefix of Foo should be 'foo ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:283:2: godoc prefix of Bar should be 'bar ' (missing)
/cluster-api/util/test/builder/v1beta2_transition.go:286:2: godoc prefix of Conditions should be 'conditions ' (missing)
/cluster-api/exp/runtime/catalog/test/catalog_test.go:188:2: godoc prefix of First should be 'first ' (missing)
/cluster-api/exp/runtime/catalog/test/catalog_test.go:199:2: godoc prefix of First should be 'first ' (missing)
/cluster-api/exp/runtime/catalog/test/catalog_test.go:205:2: godoc prefix of First should be 'first ' (missing)
/cluster-api/exp/runtime/catalog/test/catalog_test.go:216:2: godoc prefix of First should be 'first ' (missing)
  • In non test files
/cluster-api/api/v1beta1/cluster_types.go:837:2: godoc prefix of CIDRBlocks should be 'cidrBlocks ' (missing)
/cluster-api/api/v1beta1/machinehealthcheck_types.go:121:2: godoc prefix of Type should be 'type ' (missing)
/cluster-api/api/v1beta1/machinehealthcheck_types.go:129:2: godoc prefix of Timeout should be 'timeout ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go:665:2: godoc prefix of Name should be 'name ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadm_types.go:666:2: godoc prefix of Value should be 'value ' (missing)
/cluster-api/bootstrap/kubeadm/api/v1beta1/kubeadmconfigtemplate_types.go:27:2: godoc prefix of Template should be 'template ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:30:2: godoc prefix of Cluster should be 'cluster ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:31:2: godoc prefix of ControlPlane should be 'controlPlane ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:32:2: godoc prefix of MachineDeployment should be 'machineDeployment ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:33:2: godoc prefix of MachinePool should be 'machinePool ' (missing)
/cluster-api/controlplane/kubeadm/api/v1beta1/kubeadmcontrolplanetemplate_types.go:28:2: godoc prefix of Template should be 'template ' (missing)
/cluster-api/version/version.go:69:2: godoc prefix of Major should be 'major ' (missing)
/cluster-api/version/version.go:70:2: godoc prefix of Minor should be 'minor ' (missing)
/cluster-api/version/version.go:71:2: godoc prefix of GitVersion should be 'gitVersion ' (missing)
/cluster-api/version/version.go:72:2: godoc prefix of GitCommit should be 'gitCommit ' (missing)
/cluster-api/version/version.go:73:2: godoc prefix of GitTreeState should be 'gitTreeState ' (missing)
/cluster-api/version/version.go:74:2: godoc prefix of BuildDate should be 'buildDate ' (missing)
/cluster-api/version/version.go:75:2: godoc prefix of GoVersion should be 'goVersion ' (missing)
/cluster-api/version/version.go:76:2: godoc prefix of Compiler should be 'compiler ' (missing)
/cluster-api/version/version.go:77:2: godoc prefix of Platform should be 'platform ' (missing)
/cluster-api/internal/apis/core/v1alpha3/cluster_types.go:95:2: godoc prefix of CIDRBlocks should be 'cidrBlocks ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:71:2: godoc prefix of Type should be 'type ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machinehealthcheck_types.go:79:2: godoc prefix of Timeout should be 'timeout ' (missing)
/cluster-api/internal/apis/core/v1alpha3/machineset_types.go:158:2: godoc prefix of FailureMessage should be 'failureMessage ' (missing)
/cluster-api/internal/apis/core/v1alpha4/cluster_types.go:175:2: godoc prefix of CIDRBlocks should be 'cidrBlocks ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:82:2: godoc prefix of Type should be 'type ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machinehealthcheck_types.go:90:2: godoc prefix of Timeout should be 'timeout ' (missing)
/cluster-api/internal/apis/core/v1alpha4/machineset_types.go:165:2: godoc prefix of FailureMessage should be 'failureMessage ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha3/kubeadmconfigtemplate_types.go:25:2: godoc prefix of Template should be 'template ' (missing)
/cluster-api/internal/apis/bootstrap/kubeadm/v1alpha4/kubeadmconfigtemplate_types.go:25:2: godoc prefix of Template should be 'template ' (missing)
/cluster-api/cmd/clusterctl/api/v1alpha3/metadata_type.go:32:2: godoc prefix of ReleaseSeries should be 'releaseSeries ' (missing)
/cluster-api/cmd/clusterctl/cmd/version.go:32:2: godoc prefix of ClientVersion should be 'clusterctl ' (missing)
/cluster-api/internal/apis/controlplane/kubeadm/v1alpha4/kubeadmcontrolplanetemplate_types.go:25:2: godoc prefix of Template should be 'template ' (missing)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants