chore: Spelling (argoproj#215)

jsoref · crenshaw-dev · web-flow · commit 55bb49480a68 · 2022-04-12T13:35:40.000-04:00
* spelling: account

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: aggregation

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: annotations

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: argocd

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: does-not

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: donot

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: do-not

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: implementers

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: individual

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: openshift

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: relate

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: requeuing

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: settings

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: worse

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

* spelling: youtube

Signed-off-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;

Co-authored-by: Josh Soref &lt;jsoref@users.noreply.github.com&gt;
Co-authored-by: Michael Crenshaw &lt;michael@crenshaw.dev&gt;
diff --git a/pkg/cache/cluster.go b/pkg/cache/cluster.go
@@ -972,7 +972,7 @@ func (c *clusterCache) processEvent(event watch.EventType, un *unstructured.Unst
 		h(event, un)
 	}
 	key := kube.GetResourceKey(un)
-	if event == watch.Modified && skipAppRequeing(key) {
+	if event == watch.Modified && skipAppRequeuing(key) {
 		return
 	}
 
@@ -1044,8 +1044,8 @@ func (c *clusterCache) GetClusterInfo() ClusterInfo {
 	}
 }
 
-// skipAppRequeing checks if the object is an API type which we want to skip requeuing against.
+// skipAppRequeuing checks if the object is an API type which we want to skip requeuing against.
 // We ignore API types which have a high churn rate, and/or whose updates are irrelevant to the app
-func skipAppRequeing(key kube.ResourceKey) bool {
+func skipAppRequeuing(key kube.ResourceKey) bool {
 	return ignoredRefreshResources[key.Group+"/"+key.Kind]
 }
diff --git a/pkg/cache/resource_test.go b/pkg/cache/resource_test.go
@@ -52,7 +52,7 @@ metadata:
 	assert.False(t, parent.isParentOf(nonMatchingNameEndPoint))
 }
 
-func TestIsServiceAccoountParentOfSecret(t *testing.T) {
+func TestIsServiceAccountParentOfSecret(t *testing.T) {
 	serviceAccount := c.newResource(strToUnstructured(`
 apiVersion: v1
 kind: ServiceAccount
diff --git a/pkg/diff/diff.go b/pkg/diff/diff.go
@@ -391,8 +391,8 @@ func GetLastAppliedConfigAnnotation(live *unstructured.Unstructured) (*unstructu
 	if live == nil {
 		return nil, nil
 	}
-	annots := live.GetAnnotations()
-	lastAppliedStr, ok := annots[corev1.LastAppliedConfigAnnotation]
+	annotations := live.GetAnnotations()
+	lastAppliedStr, ok := annotations[corev1.LastAppliedConfigAnnotation]
 	if !ok {
 		return nil, nil
 	}
@@ -554,7 +554,7 @@ func normalizeRole(un *unstructured.Unstructured, o options) {
 		if ok {
 			_, ok = aggrIf.(map[string]interface{})
 			if !ok {
-				o.log.Info(fmt.Sprintf("Malformed aggregrationRule in resource '%s', won't modify.", un.GetName()))
+				o.log.Info(fmt.Sprintf("Malformed aggregationRule in resource '%s', won't modify.", un.GetName()))
 			} else {
 				un.Object["rules"] = nil
 			}
diff --git a/pkg/health/health.go b/pkg/health/health.go
@@ -47,7 +47,7 @@ var healthOrder = []HealthStatusCode{
 	HealthStatusUnknown,
 }
 
-// IsWorse returns whether or not the new health status code is a worser condition than the current
+// IsWorse returns whether or not the new health status code is a worse condition than the current
 func IsWorse(current, new HealthStatusCode) bool {
 	currentIndex := 0
 	newIndex := 0
diff --git a/pkg/health/testdata/pod-deletion.yaml b/pkg/health/testdata/pod-deletion.yaml
@@ -10,7 +10,7 @@ metadata:
   deletionTimestamp: 2018-12-03T10:16:04Z
 spec:
   containers:
-    - image: doesnt-exist
+    - image: does-not-exist
       imagePullPolicy: Always
       name: main
       resources: {}
@@ -59,7 +59,7 @@ status:
       status: "True"
       type: PodScheduled
   containerStatuses:
-    - image: doesnt-exist
+    - image: does-not-exist
       imageID: ""
       lastState: {}
       name: main
diff --git a/pkg/health/testdata/pod-pending.yaml b/pkg/health/testdata/pod-pending.yaml
@@ -9,7 +9,7 @@ metadata:
   uid: 46c1e8de-f61b-11e8-a057-fe5f49266390
 spec:
   containers:
-  - image: doesnt-exist
+  - image: does-not-exist
     imagePullPolicy: Always
     name: main
     resources: {}
@@ -58,7 +58,7 @@ status:
     status: "True"
     type: PodScheduled
   containerStatuses:
-  - image: doesnt-exist
+  - image: does-not-exist
     imageID: ""
     lastState: {}
     name: main
diff --git a/pkg/sync/sync_context_test.go b/pkg/sync/sync_context_test.go
@@ -455,13 +455,13 @@ func TestSyncPruneFailure(t *testing.T) {
 	assert.Equal(t, "foo", result.Message)
 }
 
-func TestDontSyncOrPruneHooks(t *testing.T) {
+func TestDoNotSyncOrPruneHooks(t *testing.T) {
 	syncCtx := newTestSyncCtx(WithOperationSettings(false, false, false, true))
 	targetPod := NewPod()
-	targetPod.SetName("dont-create-me")
+	targetPod.SetName("do-not-create-me")
 	targetPod.SetAnnotations(map[string]string{synccommon.AnnotationKeyHook: "PreSync"})
 	liveSvc := NewService()
-	liveSvc.SetName("dont-prune-me")
+	liveSvc.SetName("do-not-prune-me")
 	liveSvc.SetNamespace(FakeArgoCDNamespace)
 	liveSvc.SetAnnotations(map[string]string{synccommon.AnnotationKeyHook: "PreSync"})
 
@@ -473,7 +473,7 @@ func TestDontSyncOrPruneHooks(t *testing.T) {
 }
 
 // make sure that we do not prune resources with Prune=false
-func TestDontPrunePruneFalse(t *testing.T) {
+func TestDoNotPrunePruneFalse(t *testing.T) {
 	syncCtx := newTestSyncCtx(WithOperationSettings(false, true, false, false))
 	pod := NewPod()
 	pod.SetAnnotations(map[string]string{synccommon.AnnotationSyncOptions: "Prune=false"})
@@ -1250,7 +1250,7 @@ func TestPruneLast(t *testing.T) {
 		assert.Equal(t, 3, tasks.lastWave())
 	})
 
-	t.Run("pruneLastIndidualResources", func(t *testing.T) {
+	t.Run("pruneLastIndividualResources", func(t *testing.T) {
 		syncCtx.pruneLast = false
 
 		pod1.SetAnnotations(map[string]string{synccommon.AnnotationSyncWave: "2"})
diff --git a/pkg/sync/sync_task_test.go b/pkg/sync/sync_task_test.go
@@ -64,7 +64,7 @@ func Test_syncTask_deleteBeforeCreation(t *testing.T) {
 	// must be hook
 	assert.False(t, (&syncTask{liveObj: Annotate(NewPod(), "argocd.argoproj.io/hook-delete-policy", "BeforeHookCreation")}).deleteBeforeCreation())
 	// no need to delete if no live obj
-	assert.False(t, (&syncTask{targetObj: Annotate(Annotate(NewPod(), "argoocd.argoproj.io/hook", "Sync"), "argocd.argoproj.io/hook-delete-policy", "BeforeHookCreation")}).deleteBeforeCreation())
+	assert.False(t, (&syncTask{targetObj: Annotate(Annotate(NewPod(), "argocd.argoproj.io/hook", "Sync"), "argocd.argoproj.io/hook-delete-policy", "BeforeHookCreation")}).deleteBeforeCreation())
 	assert.True(t, (&syncTask{liveObj: Annotate(Annotate(NewPod(), "argocd.argoproj.io/hook", "Sync"), "argocd.argoproj.io/hook-delete-policy", "BeforeHookCreation")}).deleteBeforeCreation())
 	assert.True(t, (&syncTask{liveObj: Annotate(Annotate(NewPod(), "argocd.argoproj.io/hook", "Sync"), "argocd.argoproj.io/hook-delete-policy", "BeforeHookCreation")}).deleteBeforeCreation())
 
diff --git a/specs/design-bottom-up.md b/specs/design-bottom-up.md
@@ -57,7 +57,7 @@ Resources of the deprecated extensions API group have duplicates in groups apps,
 * The ReplicaSet from apps group might reference Deployment from the extensions group as a parent.
 * The relationship between Service and Endpoint is not explicit: [kubernetes/#28483](https://github.com/kubernetes/kubernetes/issues/28483)
 * The relationship between ServiceAccount and Token is not explicit.
-* Resources of Openshift deprecated groups authorization.openshift.io and project.openshift.io create
+* Resources of OpenShift deprecated groups authorization.openshift.io and project.openshift.io create
 duplicates in rbac.authorization.k8s.io and core groups.
 
 #### Top-Level Component APIs
diff --git a/specs/design-top-down.md b/specs/design-top-down.md
@@ -178,7 +178,7 @@ type Sync<Term>Store interface {
 type ReconciliationSettings struct {
 	// AppInstanceLabelKey holds label key which is automatically added to every resource managed by the application
 	AppInstanceLabelKey string
-	// ResourcesFilter holds settigns which allows to configure list of managed resource APIs
+	// ResourcesFilter holds settings which allows to configure list of managed resource APIs
 	ResourcesFilter resource.ResourcesFilter
 	// ResourceOverrides holds settings which customize resource diffing logic
 	ResourceOverrides map[scheme.GroupKind]appv1.ResourceOverride
diff --git a/specs/template.md b/specs/template.md
@@ -17,7 +17,7 @@ The title should be lowercased and spaces/punctuation should be replaced with
 The `Summary` section is incredibly important for producing high quality
 user-focused documentation such as release notes or a development roadmap.  It
 should be possible to collect this information before implementation begins in
-order to avoid requiring implementors to split their attention between writing
+order to avoid requiring implementers to split their attention between writing
 release notes and implementing the feature itself.  Ensure that the tone and
 content of the `Summary` section is useful for a wide audience.
 
@@ -51,7 +51,7 @@ bogged down.
 
 What are the caveats to the implementation?  What are some important details
 that didn't come across above.  Go in to as much detail as necessary here.
-This might be a good place to talk about core concepts and how they releate.
+This might be a good place to talk about core concepts and how they relate.
 
 ### Risks and Mitigations
 

Original file line number	Diff line number	Diff line change
`@@ -972,7 +972,7 @@ func (c clusterCache) processEvent(event watch.EventType, un unstructured.Unst`
`972`	`972`	`h(event, un)`
`973`	`973`	`}`
`974`	`974`	`key := kube.GetResourceKey(un)`
`975`		`- if event == watch.Modified && skipAppRequeing(key) {`
	`975`	`+ if event == watch.Modified && skipAppRequeuing(key) {`
`976`	`976`	`return`
`977`	`977`	`}`
`978`	`978`
`@@ -1044,8 +1044,8 @@ func (c *clusterCache) GetClusterInfo() ClusterInfo {`
`1044`	`1044`	`}`
`1045`	`1045`	`}`
`1046`	`1046`
`1047`		`-// skipAppRequeing checks if the object is an API type which we want to skip requeuing against.`
	`1047`	`+// skipAppRequeuing checks if the object is an API type which we want to skip requeuing against.`
`1048`	`1048`	`// We ignore API types which have a high churn rate, and/or whose updates are irrelevant to the app`
`1049`		`-func skipAppRequeing(key kube.ResourceKey) bool {`
	`1049`	`+func skipAppRequeuing(key kube.ResourceKey) bool {`
`1050`	`1050`	`return ignoredRefreshResources[key.Group+"/"+key.Kind]`
`1051`	`1051`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ metadata:`
`52`	`52`	`assert.False(t, parent.isParentOf(nonMatchingNameEndPoint))`
`53`	`53`	`}`
`54`	`54`
`55`		`-func TestIsServiceAccoountParentOfSecret(t *testing.T) {`
	`55`	`+func TestIsServiceAccountParentOfSecret(t *testing.T) {`
`56`	`56`	serviceAccount := c.newResource(strToUnstructured(`
`57`	`57`	`apiVersion: v1`
`58`	`58`	`kind: ServiceAccount`
Original file line number	Diff line number	Diff line change
`@@ -391,8 +391,8 @@ func GetLastAppliedConfigAnnotation(live unstructured.Unstructured) (unstructu`
`391`	`391`	`if live == nil {`
`392`	`392`	`return nil, nil`
`393`	`393`	`}`
`394`		`- annots := live.GetAnnotations()`
`395`		`- lastAppliedStr, ok := annots[corev1.LastAppliedConfigAnnotation]`
	`394`	`+ annotations := live.GetAnnotations()`
	`395`	`+ lastAppliedStr, ok := annotations[corev1.LastAppliedConfigAnnotation]`
`396`	`396`	`if !ok {`
`397`	`397`	`return nil, nil`
`398`	`398`	`}`
`@@ -554,7 +554,7 @@ func normalizeRole(un *unstructured.Unstructured, o options) {`
`554`	`554`	`if ok {`
`555`	`555`	`_, ok = aggrIf.(map[string]interface{})`
`556`	`556`	`if !ok {`
`557`		`- o.log.Info(fmt.Sprintf("Malformed aggregrationRule in resource '%s', won't modify.", un.GetName()))`
	`557`	`+ o.log.Info(fmt.Sprintf("Malformed aggregationRule in resource '%s', won't modify.", un.GetName()))`
`558`	`558`	`} else {`
`559`	`559`	`un.Object["rules"] = nil`
`560`	`560`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ var healthOrder = []HealthStatusCode{`
`47`	`47`	`HealthStatusUnknown,`
`48`	`48`	`}`
`49`	`49`
`50`		`-// IsWorse returns whether or not the new health status code is a worser condition than the current`
	`50`	`+// IsWorse returns whether or not the new health status code is a worse condition than the current`
`51`	`51`	`func IsWorse(current, new HealthStatusCode) bool {`
`52`	`52`	`currentIndex := 0`
`53`	`53`	`newIndex := 0`