docs: fix typos in comments, docs, and log messages#1302
Closed
redstartechno wants to merge 1 commit into
Closed
Conversation
Sweep with codespell across decentralized-api, inference-chain, and testermint. 16 fixes: code comments, doc prose, and a few log/error message strings. No behavior change; no identifiers or generated files touched.
Collaborator
Author
|
Closing in favor of #1306, which combines this and the other docs fixes into a single PR per the maintainer's request. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What problem does this solve?
Fixes 16 spelling typos across the codebase — in code comments, documentation prose, and a few
log/error message strings — found with
codespell.How do you know this is a real problem?
Running
codespellover the source (excluding generated*.pb.go/*.pulsar.go, vendored code,and binaries) flags these misspellings. Examples:
propogated→propagated,directy→directly,inbetween→in between,authrority→authority,unabled to unmarhsal→unable to unmarshal,subsytems→subsystems,withdrawl→withdrawal. Each misspelled token occurs exactly once inthe repo, so none is relied upon elsewhere.
How does this solve the problem?
Corrects each spelling. The full list (file → fix):
decentralized-api/internal/server/public/get_epoch.go— comment:indroduced→introduceinference-chain/app/ante_validation.go— comment:propogated→propagatedinference-chain/x/inference/keeper/poc_period_validation.go— comment:propogated→propagatedinference-chain/x/inference/keeper/bridge_native.go— comment:directy→directlyinference-chain/x/inference/keeper/msg_server_validation.go— comment:inbetween→in betweeninference-chain/x/inference/keeper/bridge_transaction_split_test.go— comment:Get's→Getstestermint/src/test/kotlin/StreamVestingTests.kt— comment:unfortunatelly→unfortunatelydecentralized-api/internal/validation/proposal.md— prose:woker→workertestermint/README.md— prose:subsytems→subsystemstestermint/mcp_log_examiner/.../logging_overview.md— prose:systen→systemtestermint/mcp_log_examiner/.../step_by_step.md— prose:regarging→regardinginference-chain/cmd/inferenced/cmd/sync_snapshots.go— error string:wih→withinference-chain/x/inference/keeper/developer_stats_aggregation.go— log string:unabled to unmarhsal→unable to unmarshalinference-chain/x/inference/types/message_register_model.go— error string:authrority→authoritytestermint/src/main/kotlin/DockerGroup.kt— log string:cluser→clustertestermint/src/test/kotlin/CollateralTests.kt— log string:withdrawl→withdrawalWhat risks does this introduce? How can we mitigate them?
Minimal. Comment and documentation edits cannot affect behavior. The few changes to string
literals are limited to human-readable log/error text; each misspelled string appears only once
in the repo, so no test or other code asserts the old spelling. No identifiers, function names,
struct fields, or proto definitions were touched, so nothing requires regeneration.
How do you know this PR fixes the problem?
Re-running
codespellwith the same scope no longer reports any of these 16 items. Remainingcodespell output consists only of false positives (e.g. the SQLite type prefix
DOUB, the@OptIn/@AfterAllannotations, short identifiers likeege) which were intentionally leftunchanged.
Which components are affected?
Documentation and comments across
decentralized-api,inference-chain, andtestermint, plusthree human-readable log/error strings. No runtime logic changes.
Testing & evidence
No code paths changed; behavior is unaffected, so automated tests are not applicable. Verification
was done with
codespell(before: 16 of these flagged; after: 0). Comment/string edits compiletrivially as they do not alter program structure.