Skip to content

Fix spelling mistakes in comments, docs, and error strings#3619

Merged
knative-prow[bot] merged 2 commits intoknative:mainfrom
Ankitsinghsisodya:fix/codespell-comment-typos
Apr 20, 2026
Merged

Fix spelling mistakes in comments, docs, and error strings#3619
knative-prow[bot] merged 2 commits intoknative:mainfrom
Ankitsinghsisodya:fix/codespell-comment-typos

Conversation

@Ankitsinghsisodya
Copy link
Copy Markdown
Contributor

@Ankitsinghsisodya Ankitsinghsisodya commented Apr 17, 2026

Changes

  • Fix ~104 spelling mistakes in source comments, package doc strings, markdown documentation, error message strings, and test strings across 65 files
  • Preserve intentional misspellings in cobra SuggestFor arrays (used for CLI autocorrect) and Kubernetes operator names in Tekton YAML templates

/kind cleanup

Fixes #3618

Release Note


Docs


Copilot AI review requested due to automatic review settings April 17, 2026 07:29
@knative-prow knative-prow bot added kind/cleanup Cleanup size/L 🤖 PR changes 100-499 lines, ignoring generated files. labels Apr 17, 2026
@knative-prow
Copy link
Copy Markdown

knative-prow bot commented Apr 17, 2026

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

@knative-prow knative-prow bot added the needs-ok-to-test 🤖 Needs an org member to approve testing label Apr 17, 2026
@knative-prow knative-prow bot requested review from dsimansk and jrangelramos April 17, 2026 07:29
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@knative-prow-robot knative-prow-robot added needs-rebase Cannot be merged due to conflicts with HEAD. and removed needs-rebase Cannot be merged due to conflicts with HEAD. labels Apr 17, 2026
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
@Ankitsinghsisodya Ankitsinghsisodya force-pushed the fix/codespell-comment-typos branch from 5fa82ac to 6ed377c Compare April 17, 2026 08:55
@knative-prow-robot knative-prow-robot removed the needs-rebase Cannot be merged due to conflicts with HEAD. label Apr 17, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 17, 2026

Codecov Report

❌ Patch coverage is 71.42857% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 56.29%. Comparing base (02faab0) to head (6ed377c).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cmd/func-util/socat.go 0.00% 1 Missing ⚠️
pkg/creds/credentials.go 0.00% 1 Missing ⚠️
pkg/filesystem/filesystem.go 0.00% 1 Missing ⚠️
pkg/keda/deployer.go 0.00% 1 Missing ⚠️
pkg/pipelines/tekton/templates.go 0.00% 1 Missing ⚠️
pkg/s2i/builder.go 0.00% 1 Missing ⚠️
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     
Flag Coverage Δ
e2e 36.20% <55.00%> (-0.03%) ⬇️
e2e go 32.86% <20.00%> (ø)
e2e node 28.64% <20.00%> (+0.02%) ⬆️
e2e python 33.23% <20.00%> (ø)
e2e quarkus 28.74% <20.00%> (-0.03%) ⬇️
e2e rust 28.18% <20.00%> (+0.06%) ⬆️
e2e springboot 26.65% <20.00%> (ø)
e2e typescript 28.71% <20.00%> (-0.02%) ⬇️
e2e-config-ci 18.08% <20.00%> (ø)
integration 17.48% <16.66%> (ø)
unit macos-14 43.35% <33.33%> (+<0.01%) ⬆️
unit macos-latest 43.35% <33.33%> (ø)
unit ubuntu-24.04-arm 43.55% <61.90%> (ø)
unit ubuntu-latest 44.23% <33.33%> (ø)
unit windows-latest 43.38% <33.33%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@gauron99 gauron99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@knative-prow knative-prow bot added the lgtm 🤖 PR is ready to be merged. label Apr 20, 2026
@knative-prow
Copy link
Copy Markdown

knative-prow bot commented Apr 20, 2026

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot added the approved 🤖 PR has been approved by an approver from all required OWNERS files. label Apr 20, 2026
@knative-prow knative-prow bot merged commit 26faef5 into knative:main Apr 20, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved 🤖 PR has been approved by an approver from all required OWNERS files. kind/cleanup Cleanup lgtm 🤖 PR is ready to be merged. needs-ok-to-test 🤖 Needs an org member to approve testing size/L 🤖 PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: correct spelling mistakes in comments, docs, and error strings

4 participants