Fix spelling mistakes in comments, docs, and error strings#3619
Conversation
|
Hi @Ankitsinghsisodya. Thanks for your PR. I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with Tip We noticed you've done this a few times! Consider joining the org to skip this step and gain Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
There was a problem hiding this comment.
Pull request overview
This PR performs a repo-wide cleanup to correct spelling mistakes across code comments, docstrings, markdown docs, test strings, and a few user-facing error strings, while preserving intentionally misspelled values used for CLI autocorrect and Tekton/Kubernetes semantics.
Changes:
- Correct spelling in template JSDoc comments for Node.js/TypeScript runtimes.
- Fix spelling/typos across Go source comments, tests, docs, and shell script comments.
- Update a small number of user-visible error strings to correct spelling.
Reviewed changes
Copilot reviewed 65 out of 65 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| templates/typescript/cloudevents/src/index.ts | Fix typo in JSDoc param description (“deserialized”). |
| templates/node/cloudevents/index.js | Fix typo in JSDoc param description (“deserialized”). |
| templates/go/http/function.go | Fix typo in shutdown/cleanup comment (“release”). |
| templates/go/cloudevents/function_test.go | Fix typo in test failure message (“didn't”). |
| schema/generator/main.go | Fix typo in generator comment (“Generated”). |
| pkg/ssh/ssh_dialer.go | Fix typo in error string (“mismatch”). |
| pkg/scaffolding/scaffold.go | Fix typo in comment (“filesystem”). |
| pkg/scaffolding/detectors_test.go | Fix typo in comment (“compile”). |
| pkg/scaffolding/detectors.go | Fix typo in comment (“receiver”). |
| pkg/s2i/builder.go | Fix typo in comment (“requested”). |
| pkg/s2i/assemblers.go | Fix typo in script comment (“connection”). |
| pkg/pipelines/tekton/templates.go | Fix typo in stderr message (“processing”). |
| pkg/pipelines/tekton/pipelines_pac_provider.go | Fix typo in doc comment (“configures”). |
| pkg/pipelines/tekton/pipelines_int_test.go | Fix typo in comment (“current”). |
| pkg/oci/go_builder.go | Fix typos in comments (“overridable”, “indicating”). |
| pkg/oci/builder_test.go | Fix typo in comment (“descriptors”). |
| pkg/oci/builder.go | Fix typo in interface comment (“generated”). |
| pkg/knative/describer.go | Fix typo in comment (“detail”). |
| pkg/knative/deployer.go | Fix typos in comments (“bootstrapping”, “current”). |
| pkg/keda/deployer.go | Fix typo in comment (“wraps”). |
| pkg/functions/testdata/repositories/customLanguagePackRepo/templates/manifestedRuntime/manifestedTemplate/manifest.yaml | Fix typo in YAML comment (“degradation”). |
| pkg/functions/testdata/README.md | Fix typo in docs (“modified”). |
| pkg/functions/templates_test.go | Fix typos in test comments/messages (“specified”, “repository”). |
| pkg/functions/repository.go | Fix typo in comment (“values”). |
| pkg/functions/repositories_test.go | Fix typos in test comments/messages (“invalid”, “builtin”, “manifest”). |
| pkg/functions/job_test.go | Fix typos in comments (“functions”, “implementation”). |
| pkg/functions/function_unit_test.go | Fix typo in comment (“doesn't”). |
| pkg/functions/function_test.go | Fix typos in test strings/comments (“should”, “or”). |
| pkg/functions/function.go | Fix typo in comment (“Calculate”). |
| pkg/functions/client_test.go | Fix typos in test strings/comments (“directives”, “modifying”, “directive”, “implementation”, “would”, “uninitialized”, “library”, “account”). |
| pkg/functions/client_int_test.go | Fix typo in comment (“synchronous”). |
| pkg/functions/client.go | Fix typos in comments (“services”, “support”, “Describe”, “pipelines”, “instance”, “opening”, “config”). |
| pkg/filesystem/filesystem_test.go | Fix typos in test strings (“mismatch”). |
| pkg/filesystem/filesystem.go | Fix typo in error string (“unsupported”). |
| pkg/docker/runner.go | Fix typos in comments (“loopback”, “because”). |
| pkg/docker/platform_test.go | Fix typo in test error strings (“unexpected”). |
| pkg/creds/credentials.go | Fix typo in error string (“failed”). |
| pkg/config/config_test.go | Fix typo in comment (“yields”). |
| pkg/config/config.go | Fix typos in comments (“intentionally”, “consisting”). |
| pkg/builders/builders.go | Fix typo in package comment (“convenience”). |
| hack/common.sh | Fix typo in comment (“matching”). |
| hack/cmd/update-builder/main.go | Fix typo in comment (“preferred”). |
| e2e/e2e_test.go | Fix typos in comments (“true”, “loopback”). |
| e2e/e2e_remote_test.go | Fix typo in comment (“source”). |
| e2e/e2e_core_test.go | Fix typo in log message (“Implemented”). |
| docs/language-packs/templates.md | Fix typo in docs (“implementations”). |
| docs/language-packs/language-pack-contract.md | Fix typos in docs (“straightforward”, “invocable”, “implementers”). |
| docs/function-templates/typescript.md | Fix spelling in docs snippet (“Invocable”). |
| docs/building-functions/podman.md | Fix typo in docs (“through”). |
| cmd/version.go | Fix typo in comment (“metadata”). |
| cmd/templates_test.go | Fix typo in test error strings (“mismatch”). |
| cmd/run_test.go | Fix typos in test strings/comments (“build”, “purview”, “running”). |
| cmd/run.go | Fix typo in comment (“already”). |
| cmd/root.go | Fix typo in comment (“nonexistent”). |
| cmd/repository_test.go | Fix typo in comment (“expected”). |
| cmd/repository.go | Fix typos in comments (“inconsistency”, “confusion”, “default”, “interactively”). |
| cmd/list_test.go | Fix typo in test case name (“specified”). |
| cmd/func-util/socat.go | Fix typo in stderr message (“warning”). |
| cmd/func-util/main.go | Fix typo in error string (“compatibility”). |
| cmd/deploy_test.go | Fix typos in comments (“additional”, “at least”, “minimum”, “function”, “error”). |
| cmd/deploy.go | Fix typo in comment (“package”). |
| cmd/delete_test.go | Fix typo in comment (“invoked”). |
| cmd/create.go | Fix typos in comments (“can't”, “library”). |
| cmd/client_test.go | Fix typo in comment (“exhaustive”). |
| cmd/build.go | Fix typo in comment (“shown”). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fix ~104 spelling mistakes found by codespell across 65 files. Fixes cover source comments, doc strings, markdown docs, error messages, and test strings. Intentional misspellings in cobra SuggestFor arrays and Kubernetes operator names are preserved. Fixes knative#3618
5fa82ac to
6ed377c
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3619 +/- ##
==========================================
- Coverage 56.30% 56.29% -0.01%
==========================================
Files 180 180
Lines 20549 20549
==========================================
- Hits 11570 11568 -2
- Misses 7778 7779 +1
- Partials 1201 1202 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Ankitsinghsisodya, gauron99 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Changes
SuggestForarrays (used for CLI autocorrect) and Kubernetes operator names in Tekton YAML templates/kind cleanup
Fixes #3618
Release Note
Docs