Fix typos using codespell CI job (#5418)

* Fix typos Signed-off-by: Eduardo Apolinario <[email protected]> * Fix unification of codespell file Signed-off-by: Eduardo Apolinario <[email protected]> * Alphabetize list of ignored words Signed-off-by: Eduardo Apolinario <[email protected]> --------- Signed-off-by: Eduardo Apolinario <[email protected]> Co-authored-by: Eduardo Apolinario <[email protected]> Signed-off-by: Andrew Dye <[email protected]>
flyteorg · May 25, 2024 · b3f3446 · b3f3446
1 parent 7931b36
commit b3f3446
Show file tree

Hide file tree

Showing 15 changed files with 29 additions and 20 deletions.
diff --git a/.codespellrc b/.codespellrc
diff --git a/.github/codespell-ignored-words b/.github/codespell-ignored-words
@@ -0,0 +1,11 @@
+ThirdParty
+bootup
+crate
+fo
+lightyear
+nd
+notin
+querys
+ser
+te
+updAt
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -25,5 +25,5 @@ jobs:
       - name: Codespell
         uses: codespell-project/actions-codespell@v2
         with:
-          skip: "*.pb,monodocs-environment.lock.yaml"
-          ignore_words_list: crate,lightyear,fo
+          skip: "*.pb,monodocs-environment.lock.yaml,.git,*.pdf,*.svg,go.sum,go.mod,*requirements.txt,gen"
+          ignore_words_file: .github/codespell-ignored-words
diff --git a/Makefile b/Makefile
@@ -143,6 +143,10 @@ lint-helm-charts:
 	# This pressuposes that you have act installed
 	act pull_request -W .github/workflows/validate-helm-charts.yaml --container-architecture linux/amd64 -e charts/event.json
 
+.PHONY: spellcheck
+spellcheck:
+	act pull_request --container-architecture linux/amd64 -W .github/workflows/codespell.yml
+
 .PHONY: clean
 clean: ## Remove the HTML files related to the Flyteconsole and Makefile
 	rm -rf cmd/single/dist .tmp_build
diff --git a/docs/deployment/configuration/generated/datacatalog_config.rst b/docs/deployment/configuration/generated/datacatalog_config.rst
@@ -553,7 +553,7 @@ otelutils.JaegerConfig
 endpoint (string)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-Endpoint for the jaeger telemtry trace ingestor
+Endpoint for the jaeger telemetry trace ingestor
 
 **Default Value**: 
 

diff --git a/docs/deployment/configuration/generated/flyteadmin_config.rst b/docs/deployment/configuration/generated/flyteadmin_config.rst
@@ -2557,7 +2557,7 @@ otelutils.JaegerConfig
 endpoint (string)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-Endpoint for the jaeger telemtry trace ingestor
+Endpoint for the jaeger telemetry trace ingestor
 
 **Default Value**: 
 

diff --git a/docs/deployment/configuration/generated/flytepropeller_config.rst b/docs/deployment/configuration/generated/flytepropeller_config.rst
@@ -869,7 +869,7 @@ otelutils.JaegerConfig
 endpoint (string)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-Endpoint for the jaeger telemtry trace ingestor
+Endpoint for the jaeger telemetry trace ingestor
 
 **Default Value**: 
 

diff --git a/docs/deployment/configuration/generated/scheduler_config.rst b/docs/deployment/configuration/generated/scheduler_config.rst
@@ -2557,7 +2557,7 @@ otelutils.JaegerConfig
 endpoint (string)
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-Endpoint for the jaeger telemtry trace ingestor
+Endpoint for the jaeger telemetry trace ingestor
 
 **Default Value**: 
 

diff --git a/flyteadmin/scheduler/doc.go b/flyteadmin/scheduler/doc.go
@@ -7,7 +7,7 @@
 //    The above actions are exposed through launchplan activation/deactivation api's and do not have separate controls.
 //    Whenever a launchplan with a schedule is activated, a new schedule entry is created in the datastore
 //    On deactivation the created scheduled and launchplan is deactivated through a flag
-//    Atmost one launchplan is active at any moment across its various versions and same semantics apply for the
+//    At most one launchplan is active at any moment across its various versions and same semantics apply for the
 //    schedules as well.
 // 2] Scheduler
 //    This component is a singleton and has its source in the current folder and is responsible for reading the schedules
@@ -78,7 +78,7 @@
 //		   by the admin. i.e admin could execute the schedules in this order T2, T1. This is rare case though
 //
 // 		c) Case when the scheduler goes down then once it comes back up it will run catch up on all the schedules using
-//		   the last snapshoted timestamp to time.Now()
+//		   the last snapshotted timestamp to time.Now()
 //
 //		d) Case when the snapshoter fails to record the last execution at T2 but has recorded at T1, where T1 < T2 ,
 //		   then new schedules would be created from T1 -> time.Now() during catchup and the idempotency aspect of the admin

diff --git a/flyteadmin/scheduler/snapshoter/doc.go b/flyteadmin/scheduler/snapshoter/doc.go
@@ -1,5 +1,5 @@
 // Package snapshoter
 // This package provides the ability to snapshot all the schedules in the scheduler job store and persist them in the DB
 // in GOB binary format. Also it provides ability to bootstrap the scheduler from this snapshot so that the scheduler
-// can run catchup for all the schedules from the snapshoted time.
+// can run catchup for all the schedules from the snapshotted time.
 package snapshoter
diff --git a/flytectl/cmd/compile/compile_test.go b/flytectl/cmd/compile/compile_test.go
@@ -55,7 +55,7 @@ func TestCompilePackage(t *testing.T) {
 
 	// invalid workflow, types do not match
 	err = compileFromPackage("testdata/bad-workflow-package.tgz")
-	assert.NotNil(t, err, "compilin an invalid workflow returns no error")
+	assert.NotNil(t, err, "compiling an invalid workflow returns no error")
 
 	// testing badly serialized task
 	err = compileFromPackage("testdata/invalidtask.tgz")

diff --git a/flytectl/proposal/README.md b/flytectl/proposal/README.md
@@ -231,7 +231,7 @@ Support
 
 ## Install all examples
 
-Today Flytesnacks houses a few examples for Flyte usage in python. When a user wants to get started with Flyte quickly, it would be preferable that all Flytesnacks examples are serialized and stored as artifacts in flytesnacks for every checkin. This can be done for python flytekit using `pyflyte serialize` command. Once they are posted as serialized blobs, flytectl could easily retrieve them and register them in a specific project as desired by the user.
+Today Flytesnacks houses a few examples for Flyte usage in python. When a user wants to get started with Flyte quickly, it would be preferable that all Flytesnacks examples are serialized and stored as artifacts in flytesnacks for every commit to master. This can be done for python flytekit using `pyflyte serialize` command. Once they are posted as serialized blobs, flytectl could easily retrieve them and register them in a specific project as desired by the user.
 
 ```bash
 $ flytectl examples register-all [cookbook|plugins|--custom-path=remote-path] [--semver semantic-version-of-flytesnacks-examples] --target-project --target-domain

diff --git a/flyteidl/clients/go/admin/cache/token_cache_inmemory.go b/flyteidl/clients/go/admin/cache/token_cache_inmemory.go
@@ -50,7 +50,7 @@ func (t *TokenCacheInMemoryProvider) Unlock() {
 // It also locks the Locker in the condition variable as the semantics of Wait is that it unlocks the Locker after adding
 // the consumer to the waitlist and before blocking on notification.
 // We use the condLocker which is noOp locker to get added to waitlist for notifications.
-// The underlying notifcationList doesn't need to be guarded as it implmentation is atomic and is thread safe
+// The underlying notifcationList doesn't need to be guarded as it implementation is atomic and is thread safe
 // Refer https://go.dev/src/runtime/sema.go
 // Following is the function and its comments
 // notifyListAdd adds the caller to a notify list such that it can receive

diff --git a/flytestdlib/otelutils/config.go b/flytestdlib/otelutils/config.go
@@ -65,7 +65,7 @@ type FileConfig struct {
 }
 
 type JaegerConfig struct {
-	Endpoint string `json:"endpoint" pflag:",Endpoint for the jaeger telemtry trace ingestor"`
+	Endpoint string `json:"endpoint" pflag:",Endpoint for the jaeger telemetry trace ingestor"`
 }
 
 type OtlpGrpcConfig struct {

diff --git a/flytestdlib/otelutils/config_flags.go b/flytestdlib/otelutils/config_flags.go