docs: fix function comments to match their declaration names

Several godoc comments led with a stale or incorrect identifier, left
over from renames, exported/unexported changes, copy-paste between
sibling declarations, or plain typos. As a result the documented name no
longer matched the function, method, type, or var it describes. Correct
each leading word to the name of the declaration it documents.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
(cherry picked from commit 49612461a4)
This commit is contained in:
Joshua Hoblitt authored and Mergify committed 2026-06-29 19:04:45 +00:00
1 parent 7945914b21
commit dcd4dfb2bd
23 files changed
+33 -33

No files matched your search

+2 -2
View File
@@ -313,7 +313,7 @@ func (k8sh *K8sHelper) WaitForCustomResourceDeletion(namespace, name string, che
return fmt.Errorf("timed out waiting for deletion of custom resource %q", name)
}
// DeleteResource performs a kubectl delete on give args.
// DeleteResourceAndWait performs a kubectl delete on give args.
// If wait is false, a flag will be passed to indicate the delete should return immediately
func (k8sh *K8sHelper) DeleteResourceAndWait(wait bool, args ...string) error {
if !wait {
@@ -987,7 +987,7 @@ func (k8sh *K8sHelper) IsDefaultStorageClassPresent() (bool, error) {
return false, nil
}
// CheckPvcCount returns True if expected number pvs for a app are found
// CheckPvcCountAndStatus returns True if expected number pvs for a app are found
func (k8sh *K8sHelper) CheckPvcCountAndStatus(podName string, namespace string, expectedPvcCount int, expectedStatus string) bool {
logger.Infof("wait until %d pvc for app=%s are present", expectedPvcCount, podName)
listOpts := metav1.ListOptions{LabelSelector: "app=" + podName}