Corrected Some Spelling And Grammatical Errors (#1980)

Signed-off-by: Daniel Hu <[email protected]>

Author: daniel-hutao

cmd/training-operator.v1/main.go

@@ -47,7 +47,7 @@ import (
 )
 
 const (
-	// EnvKubeflowNamespace is a environment variable for namespace when deployed on kubernetes
+	// EnvKubeflowNamespace is an environment variable for namespace when deployed on kubernetes
 	EnvKubeflowNamespace = "KUBEFLOW_NAMESPACE"
 )
 

pkg/controller.v1/common/job.go

@@ -120,14 +120,14 @@ func (jc *JobController) ReconcileJobs(
 
 	oldStatus := jobStatus.DeepCopy()
 	if commonutil.IsFinished(jobStatus) {
-		// If the Job is succeed or failed, delete all pods, services, and podGroup.
+		// If the Job is succeeded or failed, delete all pods, services, and podGroup.
 		if err = jc.CleanUpResources(runPolicy, runtimeObject, metaObject, jobStatus, pods); err != nil {
 			return err
 		}
 
 		// At this point the pods may have been deleted.
 		// 1) If the job succeeded, we manually set the replica status.
-		// 2) If any replicas are still active, set their status to succeeded.
+		// 2) If any replicas are still active, set their status to 'succeeded'.
 		if commonutil.IsSucceeded(jobStatus) {
 			for rtype := range jobStatus.ReplicaStatuses {
 				jobStatus.ReplicaStatuses[rtype].Succeeded += jobStatus.ReplicaStatuses[rtype].Active
@@ -192,7 +192,7 @@ func (jc *JobController) ReconcileJobs(
 	if runPolicy.BackoffLimit != nil {
 		jobHasNewFailure := failed > prevReplicasFailedNum
 		// new failures happen when status does not reflect the failures and active
-		// is different than parallelism, otherwise the previous controller loop
+		// is different from parallelism, otherwise the previous controller loop
 		// failed updating status so even if we pick up failure it is not a new one
 		exceedsBackoffLimit = jobHasNewFailure && (active != totalReplicas) &&
 			(int32(previousRetry)+1 > *runPolicy.BackoffLimit)

pkg/controller.v1/common/pod.go

@@ -44,12 +44,12 @@ import (
 const (
 	// podTemplateRestartPolicyReason is the warning reason when the restart
 	// policy is set in pod template.
-	podTemplateRestartPolicyReason = "SettedPodTemplateRestartPolicy"
+	podTemplateRestartPolicyReason = "SetPodTemplateRestartPolicy"
 	// exitedWithCodeReason is the normal reason when the pod is exited because of the exit code.
 	exitedWithCodeReason = "ExitedWithCode"
 	// podTemplateSchedulerNameReason is the warning reason when other scheduler name is set
 	// in pod templates with gang-scheduling enabled
-	podTemplateSchedulerNameReason = "SettedPodTemplateSchedulerName"
+	podTemplateSchedulerNameReason = "SetPodTemplateSchedulerName"
 )
 
 var (
@@ -167,7 +167,7 @@ func (jc *JobController) DeletePod(obj interface{}) {
 
 	logger := commonutil.LoggerForPod(pod, jc.Controller.GetAPIGroupVersionKind().Kind)
 
-	// When a delete is dropped, the relist will notice a pod in the store not
+	// When delete is dropped, the relist will notice a pod in the store not
 	// in the list, leading to the insertion of a tombstone object which contains
 	// the deleted key/value. Note that this value might be stale. If the pod
 	// changed labels the new job will not be woken up till the periodic resync.

pkg/controller.v1/common/service.go

@@ -11,6 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
 package common
 
 import (
@@ -99,7 +100,7 @@ func (jc *JobController) DeleteService(obj interface{}) {
 	// TODO(CPH): handle this gracefully.
 }
 
-// getServicesForJob returns the set of services that this job should manage.
+// GetServicesForJob returns the set of services that this job should manage.
 // It also reconciles ControllerRef by adopting/orphaning.
 // Note that the returned services are pointers into the cache.
 func (jc *JobController) GetServicesForJob(jobObject interface{}) ([]*v1.Service, error) {
@@ -151,7 +152,7 @@ func (jc *JobController) GetServiceSlices(services []*v1.Service, replicas int,
 	return core.GetServiceSlices(services, replicas, logger)
 }
 
-// reconcileServices checks and updates services for each given ReplicaSpec.
+// ReconcileServices checks and updates services for each given ReplicaSpec.
 // It will requeue the job in case of an error while creating/deleting services.
 func (jc *JobController) ReconcileServices(
 	job metav1.Object,

pkg/controller.v1/pytorch/elastic.go

@@ -46,9 +46,6 @@ const (
 	EnvMonitorInterval = "PET_MONITOR_INTERVAL"
 	// EnvStartMethod is the environment variable name for the multiprocessing start method to use when creating workers, which could be fork, spawn and forkserver.
 	EnvStartMethod = "PET_START_METHOD"
-
-	// EnvNNodes is the common environment variable name from envvar
-
 	// EnvNProcPerNode is the environment variable name for the number of processes per node.
 	EnvNProcPerNode = "PET_NPROC_PER_NODE"
 )

pkg/controller.v1/pytorch/pytorchjob_controller.go

@@ -337,9 +337,9 @@ func (r *PyTorchJobReconciler) DeleteJob(job interface{}) error {
 	return nil
 }
 
-func (jc *PyTorchJobReconciler) GenLabelSelector(jobName string,
+func (r *PyTorchJobReconciler) GenLabelSelector(jobName string,
 	rtype kubeflowv1.ReplicaType) *metav1.LabelSelector {
-	labels := jc.GenLabels(jobName)
+	labels := r.GenLabels(jobName)
 	labels[kubeflowv1.ReplicaTypeLabel] = strings.ToLower(string(rtype))
 
 	return &metav1.LabelSelector{