Skip to content

Fix typos and misspellings in comments, tests, and docs#52277

Merged
thaJeztah merged 1 commit intomoby:masterfrom
nvsahana:fix-typos-comments
Apr 3, 2026
Merged

Fix typos and misspellings in comments, tests, and docs#52277
thaJeztah merged 1 commit intomoby:masterfrom
nvsahana:fix-typos-comments

Conversation

@nvsahana
Copy link
Copy Markdown
Contributor

@nvsahana nvsahana commented Apr 1, 2026

What I did

Fixed 20 spelling mistakes across 17 files in the codebase, found using codespell.

How I did it

Ran codespell across the repo (excluding vendor directories), manually verified each finding to exclude false positives, and corrected only clear misspellings.

Changes

File Typo Fix
daemon/daemon.go multipler multiplier
daemon/cluster/convert/network.go (x2) suppplied supplied
daemon/images/image.go desserializing deserializing
daemon/cluster/executor/container/executor.go wil will
daemon/kill.go didnt didn't
daemon/migration_test.go (x2) thats that's
daemon/cluster/controllers/plugin/controller_test.go cancelation cancellation
daemon/logger/loggerutils/logfile_test.go randome random
client/image_import.go mutiple multiple
client/service_logs.go ths the
client/task_logs.go ths the
contrib/otel/README.md buiding building
integration/volume/mount_test.go servives survives
integration-cli/docker_api_swarm_service_test.go (x2) 3nd 3rd
integration/daemon/daemon_test.go shouldnt shouldn't
pkg/pools/pools_test.go writter writer
pkg/plugins/pluginrpc-gen/parser.go exected expected

How to verify it

All changes are in comments, string literals in tests, and documentation - no functional code is affected.

Description for the changelog

Fix various typos and misspellings in comments, tests, and documentation.

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

Thanks! Left one suggestion; also could you remove the "body" from the commit message? It's very verbose, and doesn't add real value; for typo-fixes, just a title is usually enough;

Fix typos and misspellings in comments, tests, and docs
- Fix various spelling mistakes found across the codebase using codespell:
- 
- - daemon/daemon.go: multipler -> multiplier
- - daemon/cluster/convert/network.go: suppplied -> supplied (x2)
- - daemon/images/image.go: desserializing -> deserializing
- - daemon/cluster/executor/container/executor.go: wil -> will
- - daemon/kill.go: didnt -> didn't
- - daemon/migration_test.go: thats -> that's (x2)
- - daemon/cluster/controllers/plugin/controller_test.go: cancelation -> cancellation
- - daemon/logger/loggerutils/logfile_test.go: randome -> random
- - client/image_import.go: mutiple -> multiple
- - client/service_logs.go: ths -> the
- - client/task_logs.go: ths -> the
- - contrib/otel/README.md: buiding -> building
- - integration/volume/mount_test.go: servives -> survives
- - integration-cli/docker_api_swarm_service_test.go: 3nd -> 3rd (x2)
- - integration/daemon/daemon_test.go: shouldnt -> shouldn't
- - pkg/pools/pools_test.go: writter -> writer
- - pkg/plugins/pluginrpc-gen/parser.go: exected -> expected

Signed-off-by: Sahana Narasipura Vasudevarao <[email protected]>

Comment thread daemon/migration_test.go Outdated
},
{
name: "gd with an image thats no longer available",
name: "gd with an image that's no longer available",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Perhaps we should use a slightly shorter name for this; this is also used as part of the test name;

=== RUN   TestContainerMigrateOS/gd_with_an_image_that's_no_longer_available

Which can also be used to filter which tests to run, making the ' a bit more tricky to specify (either escape or quote);

go test -v -run TestContainerMigrateOS/c8d_with_an_image_that\'s_no_longer_available
=== RUN   TestContainerMigrateOS
=== RUN   TestContainerMigrateOS/c8d_with_an_image_that's_no_longer_available
--- PASS: TestContainerMigrateOS (0.00s)
    --- PASS: TestContainerMigrateOS/c8d_with_an_image_that's_no_longer_available (0.00s)
...

go test -v -run "TestContainerMigrateOS/c8d_with_an_image_that\'s_no_longer_available"
=== RUN   TestContainerMigrateOS
=== RUN   TestContainerMigrateOS/c8d_with_an_image_that's_no_longer_available
--- PASS: TestContainerMigrateOS (0.00s)
    --- PASS: TestContainerMigrateOS/c8d_with_an_image_that's_no_longer_available (0.00s)

Maybe something like;

name: "gd with missing image",

Comment thread daemon/migration_test.go Outdated
},
{
name: "c8d with an image thats no longer available",
name: "c8d with an image that's no longer available",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same for this one;

name: "c8d with missing image",

@nvsahana nvsahana force-pushed the fix-typos-comments branch from ae7d1fa to faeb315 Compare April 2, 2026 17:26
@nvsahana
Copy link
Copy Markdown
Contributor Author

nvsahana commented Apr 2, 2026

Done! Shortened the test names and trimmed the commit message body.

@thaJeztah
Copy link
Copy Markdown
Member

Thanks! Yes, some commit messages must be long to describe details that may not be clear from the diff itself, but for typo fixes it's the reverse; the diff itself should be self explanatory 😅

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread client/image_import.go
}
if p := formatPlatform(options.Platform); p != "unknown" {
// TODO(thaJeztah): would we ever support mutiple platforms here? (would require multiple rootfs tars as well?)
// TODO(thaJeztah): would we ever support multiple platforms here? (would require multiple rootfs tars as well?)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

oh! I just realise this is touching a file in the client module; you probably need to run hack/vendor.sh to re-vendor the file (as it's a dependency for the moby v2 module, which uses vendoring)

Signed-off-by: Sahana Narasipura Vasudevarao <[email protected]>
@nvsahana nvsahana force-pushed the fix-typos-comments branch from faeb315 to 07a5e92 Compare April 2, 2026 21:21
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

@thaJeztah
Copy link
Copy Markdown
Member

Failures are unrelated

@thaJeztah
Copy link
Copy Markdown
Member

Failures are unrelated

(Narrator voice) to past me: they actually .... were related #52300 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/refactor PR's that refactor, or clean-up code module/client status/4-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants