resolved lint errors

This commit resolves the lint errors caused during the checks for previous commit.

Author: Surya-7890

internal/contract/version.go

@@ -124,7 +124,7 @@ func GetLatestContractAndAPIVersionFromContract(metadata metav1.Object, currentC
 
 	sortedCompatibleContractVersions := kubeAwareAPIVersions(GetCompatibleVersions(currentContractVersion).UnsortedList())
 	slices.SortFunc(sortedCompatibleContractVersions, func(i, j string) int {
-		return sortedCompatibleContractVersions.SortFunc(i, j, DESCENDING)
+		return sortedCompatibleContractVersions.SortFunc(i, j, descending)
 	})
 
 	for _, contractVersion := range sortedCompatibleContractVersions {
@@ -139,7 +139,7 @@ func GetLatestContractAndAPIVersionFromContract(metadata metav1.Object, currentC
 		// Pick the latest version in the slice and validate it.
 		kubeVersions := kubeAwareAPIVersions(strings.Split(supportedVersions, "_"))
 		slices.SortFunc(kubeVersions, func(i, j string) int {
-			return kubeVersions.SortFunc(i, j, ASCENDING)
+			return kubeVersions.SortFunc(i, j, ascending)
 		})
 		return contractVersion, kubeVersions[len(kubeVersions)-1], nil
 	}
@@ -192,19 +192,23 @@ func GetGKMetadata(ctx context.Context, c client.Reader, gk schema.GroupKind) (*
 // versions. e.g. v2, v1, v1beta2, v1beta1, v1alpha1.
 type kubeAwareAPIVersions []string
 
+// SortFunc uses these constants to determine the order of sorting
 const (
-	ASCENDING = iota
-	DESCENDING
+	// Used to sort in ascending order of occurance
+	ascending = iota
+
+	// Used to sort in descending order of occurance
+	descending
 )
 
 func (k kubeAwareAPIVersions) SortFunc(i, j string, order int) int {
 	if k8sversion.CompareKubeAwareVersionStrings(i, j) < 0 {
-		if order == ASCENDING {
+		if order == ascending {
 			return -1
 		}
 		return 1
 	}
-	if order == ASCENDING {
+	if order == ascending {
 		return 1
 	}
 	return -1

internal/controllers/machinedeployment/machinedeployment_sync.go

@@ -425,11 +425,11 @@ func (r *Reconciler) scale(ctx context.Context, deployment *clusterv1.MachineDep
 		switch {
 		case deploymentReplicasToAdd > 0:
 			slices.SortFunc(allMSs, func(a, b *clusterv1.MachineSet) int {
-				return mdutil.SortBySize(a, b, mdutil.NEW_TO_OLD)
+				return mdutil.SortBySize(a, b, mdutil.DESCENDING)
 			})
 		case deploymentReplicasToAdd < 0:
 			slices.SortFunc(allMSs, func(a, b *clusterv1.MachineSet) int {
-				return mdutil.SortBySize(a, b, mdutil.OLD_TO_NEW)
+				return mdutil.SortBySize(a, b, mdutil.ASCENDING)
 			})
 		}
 

internal/controllers/machinedeployment/mdutil/util.go

@@ -42,15 +42,18 @@ import (
 	"sigs.k8s.io/cluster-api/util/conversion"
 )
 
+// Sort functions in this file, use these constants to determine the sorting order
 const (
+	// Used to sort elements in Ascending order
+	// Also used in cases, where the order is from older to newer occurances
 	ASCENDING = iota
+
+	// Used to sort elements in Descending order
+	// Also used in cases, where the order is from newer to older occurances
 	DESCENDING
-	OLD_TO_NEW
-	NEW_TO_OLD
 )
 
-// MachineSetsByCreationTimestamp sorts a list of MachineSet by creation timestamp, using their names as a tie breaker.
-// type MachineSetsByCreationTimestamp []*clusterv1.MachineSet
+// SortByCreationTimestamp sorts a list of MachineSet by creation timestamp, using their names as a tie breaker.
 func SortByCreationTimestamp(a, b *clusterv1.MachineSet, order int) int {
 	if b.CreationTimestamp.Equal(&a.CreationTimestamp) {
 		if b.Name > a.Name {
@@ -81,28 +84,27 @@ func SortByCreationTimestamp(a, b *clusterv1.MachineSet, order int) int {
 }
 
 // SortBySize sorts a list of MachineSet by size in descending order, using their creation timestamp or name as a tie breaker.
-// By using the creation timestamp, this sorts from old to new machine sets if order is OLD_TO_NEW or new to old machine sets if order is NEW_TO_OLD.
+// By using the creation timestamp, this sorts from old to new machine sets if order is ASCENDING or new to old machine sets if order is DESCENDING.
 func SortBySize(a, b *clusterv1.MachineSet, order int) int {
 	if *(a.Spec.Replicas) == *(b.Spec.Replicas) {
-		if order == OLD_TO_NEW {
+		if order == ASCENDING {
 			if a.CreationTimestamp.Before(&b.CreationTimestamp) {
 				return -1
 			}
 			return 1
-		} else {
-			if b.CreationTimestamp.Before(&a.CreationTimestamp) {
-				return -1
-			}
-			return 1
 		}
+		if b.CreationTimestamp.Before(&a.CreationTimestamp) {
+			return -1
+		}
+		return 1
 	}
 	if *(a.Spec.Replicas) > *(b.Spec.Replicas) {
 		return -1
 	}
 	return 1
 }
 
-// MachineSetsByDecreasingReplicas sorts the list of MachineSets in decreasing order of replicas,
+// SortByDecreasingReplicas sorts the list of MachineSets in decreasing order of replicas,
 // using creation time (ascending order) and name (alphabetical) as tie breakers.
 func SortByDecreasingReplicas(a, b *clusterv1.MachineSet) int {
 	if a.Spec.Replicas == nil {