chore: update all uses of v50 in doc references #24574
Conversation
Ironbird - launch a networkTo use Ironbird, you can use the following commands:
Custom Load Test ConfigurationYou can provide a custom load test configuration using the `--load-test-config=` flag:Use |
📝 WalkthroughWalkthroughThis update revises multiple documentation files across the codebase to reference newer versions of the Cosmos SDK in all example code links and source references. Specifically, URLs pointing to version Changes
Sequence Diagram(s)No sequence diagram generated, as the changes are limited to documentation reference updates and do not affect control flow or introduce new features. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/docs/build/building-modules/08-genesis.md (1)
74-74: Refine wording for conciseness
Consider replacing “submit state transitions prior to the first block” with “submit state transitions before the first block” to improve readability.- `GenesisTxHandler` is a way for modules to submit state transitions prior to the first block. + `GenesisTxHandler` is a way for modules to submit state transitions before the first block.🧰 Tools
🪛 LanguageTool
[style] ~74-~74: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...for modules to submit state transitions prior to the first block. This is used by `x/gen...(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/docs/learn/advanced/07-cli.md (1)
60-60: Nitpick: repetitive sentence structure
Line 60 starts multiple sentences with "For". Consider rephrasing to improve readability and avoid redundancy.🧰 Tools
🪛 LanguageTool
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../blob/v0.53.0-rc.4/client/keys/add.go). For more details about usage of `--keyring-...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...--keyring-backendfor storage of key credentials look at the [keyring docs](../../user/r...(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/build/building-modules/02-messages-and-queries.md (1)
37-37: Verify and improve version consistency in code references
TheMsgandQueryexample URLs have been updated tov0.53.0-rc.4, which is correct. However, several references still use specific commit hashes (e.g.,types/tx_msg.go, one protobuf example). For long-term stability and consistency, consider switching these to tag-based URLs (blob/v0.53.0-rc.4/...).Also applies to: 102-102, 136-136
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (28)
RELEASE_PROCESS.md(1 hunks)depinject/README.md(1 hunks)depinject/appconfig/README.md(1 hunks)docs/docs/build/building-apps/00-app-go.md(1 hunks)docs/docs/build/building-apps/04-vote-extensions.md(1 hunks)docs/docs/build/building-modules/01-module-manager.md(14 hunks)docs/docs/build/building-modules/02-messages-and-queries.md(3 hunks)docs/docs/build/building-modules/03-msg-services.md(3 hunks)docs/docs/build/building-modules/04-query-services.md(1 hunks)docs/docs/build/building-modules/06-beginblock-endblock.md(1 hunks)docs/docs/build/building-modules/06-keeper.md(2 hunks)docs/docs/build/building-modules/07-invariants.md(3 hunks)docs/docs/build/building-modules/08-genesis.md(4 hunks)docs/docs/build/building-modules/09-module-interfaces.md(7 hunks)docs/docs/build/building-modules/12-errors.md(2 hunks)docs/docs/build/building-modules/13-upgrade.md(2 hunks)docs/docs/build/building-modules/15-depinject.md(5 hunks)docs/docs/build/building-modules/16-testing.md(2 hunks)docs/docs/build/tooling/00-protobuf.md(1 hunks)docs/docs/learn/advanced/00-baseapp.md(15 hunks)docs/docs/learn/advanced/03-node.md(3 hunks)docs/docs/learn/advanced/04-store.md(11 hunks)docs/docs/learn/advanced/07-cli.md(8 hunks)x/auth/tx/README.md(1 hunks)x/auth/vesting/README.md(3 hunks)x/evidence/README.md(2 hunks)x/group/README.md(15 hunks)x/group/internal/orm/README.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/learn/advanced/03-node.md
[uncategorized] ~84-~84: A punctuation mark might be missing here.
Context: ...on.go#L9-L35) (given that app extends baseapp). As part of ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
docs/docs/build/building-modules/09-module-interfaces.md
[style] ~55-~55: Consider removing “of” to be more concise
Context: ...ws the root command to easily aggregate all of the transaction commands for each module. H...
(ALL_OF_THE)
x/group/internal/orm/README.md
[style] ~124-~124: Consider a shorter alternative to avoid wordiness.
Context: ...rip the RowID from the full index key in order to get the underlying value in the table p...
(IN_ORDER_TO_PREMIUM)
docs/docs/build/building-modules/08-genesis.md
[style] ~74-~74: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...for modules to submit state transitions prior to the first block. This is used by `x/gen...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/docs/build/building-modules/03-msg-services.md
[uncategorized] ~30-~30: A punctuation mark might be missing here.
Context: ... When possible, the existing module's [Keeper`](./06-keeper.md) should implemen...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
docs/docs/build/building-modules/16-testing.md
[grammar] ~29-~29: The word “walkthrough” is a noun. The verb is spelled with a space.
Context: ...). ### Example As an example, we will walkthrough the [keeper tests](https://github.com/c...
(NOUN_VERB_CONFUSION)
[uncategorized] ~31-~31: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...h requires a few external dependencies (ie. imports outside x/gov to work properl...
(I_E)
[style] ~36-~36: Consider a shorter alternative to avoid wordiness.
Context: ...c.4/x/gov/keeper/keeper.go#L22-L24 ``` In order to only test x/gov, we mock the [expecte...
(IN_ORDER_TO_PREMIUM)
docs/docs/learn/advanced/07-cli.md
[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../blob/v0.53.0-rc.4/client/keys/add.go). For more details about usage of `--keyring-...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ... --keyring-backend for storage of key credentials look at the [keyring docs](../../user/r...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~66-~66: Consider removing “of” to be more concise
Context: ...be run before every execution, and adds all of the necessary subcommands. ```go reference...
(ALL_OF_THE)
docs/docs/learn/advanced/04-store.md
[uncategorized] ~69-~69: You might be missing the article “the” here.
Context: ...ead caching and write branching through Write method: ```go reference https://...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~121-~121: A punctuation mark might be missing here.
Context: ...is the default multistore store used in baseapp. ### CacheMu...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~195-~195: A punctuation mark might be missing here.
Context: ...t stores are typically accessed via the context via the `Tran...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~245-~245: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...thKVGasConfigmethod of thecontext`. Otherwise it uses the following default: ```go r...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: repo-analysis
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: Check docs build
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (93)
docs/docs/build/building-apps/04-vote-extensions.md (1)
43-43: Approved updated version reference.The
go referenceURL forsdk.VerifyVoteExtensionHandlernow correctly points to thev0.53.0-rc.4tag (lines 26–27), aligning this doc with the other updated links.docs/docs/build/building-apps/00-app-go.md (1)
13-13: Approve documentation version bump.
The GitHub reference URL has been correctly updated fromv0.50.0-alpha.0tov0.53.0-rc.4, aligning with the PR objectives to modernize doc links.RELEASE_PROCESS.md (1)
248-248: Approve release branch update.
The Store v1 release branch reference has been changed torelease/v0.53.x, matching the version bump across documentation.depinject/README.md (1)
78-78: Approve depinject example link update.
TheProvideModuleexample now points to therelease/v0.53.xbranch, ensuring consistency with other docs.depinject/appconfig/README.md (1)
204-204: Approve appconfig example link update.
The link toapp_config.goundersimappnow referencesrelease/v0.53.x, keeping the version references in sync.docs/docs/build/tooling/00-protobuf.md (2)
14-14: Approve Makefile snippet link update.
The URL for the Makefile snippet has been updated tov0.53.0-rc.4, consistent with the new release candidate.
20-20: Approve protocgen script link update.
Theprotocgen.shreference now correctly usesv0.53.0-rc.4, aligning with the overarching doc updates.docs/docs/build/building-modules/04-query-services.md (1)
37-37: Approve updated gRPC example reference
Updated the Protobuf gRPC service implementation link fromv0.50.0-alpha.0tov0.53.0-rc.4as intended.x/auth/tx/README.md (1)
38-38: Approve updatedx/auth/txreference URLs
All Go reference URLs forTxConfig, its default implementation, andTxBuilderhave been correctly updated to release v0.53.x.Also applies to: 44-44, 50-50
x/evidence/README.md (1)
222-222: Approve updated evidence module reference URLs
The Protobuf and Go source code links forEquivocationevidence and infraction handling have been correctly bumped to release v0.53.x.Also applies to: 246-246
x/group/README.md (1)
104-104: Approve updatedx/groupmodule reference URLs
All Go and Protobuf reference URLs have been systematically updated from v0.50.x to release v0.53.x.Also applies to: 340-340, 353-353, 368-368, 378-378, 391-391, 405-405, 415-415, 425-425, 438-438, 452-452, 465-465, 479-479, 492-492, 505-505
docs/docs/build/building-modules/08-genesis.md (1)
25-25: Approve updated genesis module reference URLs
The documentation links forGenesisState,DefaultGenesis(),ValidateGenesis(),InitGenesis,ExportGenesis, andGenesisTxHandlerhave been correctly updated to v0.53.0-rc.4.Also applies to: 35-35, 43-43, 59-59, 69-69, 77-77
x/auth/vesting/README.md (6)
75-77: Approve: Updated BaseVestingAccount protobuf reference to v0.53.x
The link now correctly points torelease/v0.53.xinstead ofrelease/v0.50.x.
81-83: Approve: Updated ContinuousVestingAccount protobuf reference to v0.53.x
The URL has been updated to thev0.53.xbranch as expected.
87-89: Approve: Updated DelayedVestingAccount protobuf reference to v0.53.x
The link now references thev0.53.xbranch.
93-95: Approve: Updated Period protobuf reference to v0.53.x
The URL was correctly updated to point atv0.53.x.
105-107: Approve: Updated PeriodicVestingAccount protobuf reference to v0.53.x
The reference URL is now on thev0.53.xbranch.
125-127: Approve: Updated PermanentLockedAccount protobuf reference to v0.53.x
The link now correctly points tov0.53.x.docs/docs/build/building-modules/09-module-interfaces.md (7)
29-31: Approve: Updated transaction CLI example link to v0.53.0-rc.4
The URL now referencesv0.53.0-rc.4instead ofv0.50.0-alpha.0.
51-53: Approve: Updated NewTxCmd example link to v0.53.0-rc.4
The example link now points to the correct release candidate.
57-59: Approve: Updated GetTxCmd example link to v0.53.0-rc.4
The URL correctly uses thev0.53.0-rc.4tag.
69-72: Approve: Updated GetAccount query example link to v0.53.0-rc.4
The reference to the query CLI now points tov0.53.0-rc.4.
90-94: Approve: Updated GetQueryCmd example link to v0.53.0-rc.4
The URL now targets thev0.53.0-rc.4branch.
124-128: Approve: Updated AddTxFlagsToCmd reference to v0.53.0-rc.4
The link toclient/flags/flags.gonow usesv0.53.0-rc.4.
134-136: Approve: Updated AddQueryFlagsToCmd reference to v0.53.0-rc.4
The example link is now correctly pointing atv0.53.0-rc.4.docs/docs/learn/advanced/03-node.md (7)
26-28: Approve: Updated config.go reference to v0.53.0-rc.4
The documentation now links to the updatedv0.53.0-rc.4config.go.
38-42: Approve: Updated simapp main.go reference to v0.53.0-rc.4
The example now correctly points to thev0.53.0-rc.4simd/main.go.🧰 Tools
🪛 LanguageTool
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...setup.go#L74-L78 ``` See an example ofmainfunction from the `simapp` applica...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
62-64: Approve: Updated server start.go reference (appCreator) to v0.53.0-rc.4
The link now reflects thev0.53.0-rc.4version.
66-70: Approve: Updated AppCreator signature reference to v0.53.0-rc.4
The example link toapp.gois now onv0.53.0-rc.4.
73-76: Approve: Updated simapp root_v2.go reference to v0.53.0-rc.4
The code link correctly uses the new release candidate tag.
78-82: Approve: Updated CometBFT node instantiation link to v0.53.0-rc.4
The reference now points tov0.53.0-rc.4.
87-90: Approve: Updated CometBFT node start link to v0.53.0-rc.4
The documentation now references the correct version.docs/docs/build/building-modules/12-errors.md (2)
23-25: Approve: Updated distribution errors reference to v0.53.0-rc.4
The example link now points to the updated version.
45-47: Approve: Updated bank keeper error wrapping reference to v0.53.0-rc.4
The URL has been correctly updated to the new tag.docs/docs/build/building-modules/13-upgrade.md (2)
48-50: Approve: Updated migrations.go reference to v0.53.0-rc.4
The link to themigrations.gofile now usesv0.53.0-rc.4.
63-63: Approve: Updated migrateBalanceKeys example link to v0.53.0-rc.4
The inline link now correctly points to thev0.53.0-rc.4version.x/group/internal/orm/README.md (10)
24-24: Documentation link updated to v0.53.x
The reference now correctly points to therelease/v0.53.xbranch of thetable.gosource.
45-45: Documentation link updated to v0.53.x
Theauto_uint64.gocode reference was updated to therelease/v0.53.xbranch.
59-59: Documentation link updated to v0.53.x
Theprimary_key.goreference URL now points torelease/v0.53.x.
78-78: Documentation link updated to v0.53.x
Thetypes.gocode reference URL was updated to therelease/v0.53.xbranch.
86-86: Documentation link updated to v0.53.x
Theindex.goreference now correctly points torelease/v0.53.x.
96-96: Documentation link updated to v0.53.x
Theindexer.goURL has been updated torelease/v0.53.x.
115-115: Documentation link updated to v0.53.x
Thetypes.goiterator reference now points torelease/v0.53.x.
121-121: Documentation link updated to v0.53.x
Thetable.goiterator snippet reference is now onrelease/v0.53.x.
127-127: Documentation link updated to v0.53.x
The secondary index iterator URL has been updated torelease/v0.53.x.
138-138: Documentation link updated to v0.53.x
The pagination implementation link now points torelease/v0.53.x.docs/docs/build/building-modules/07-invariants.md (5)
22-22: Updated code reference URL to v0.53.0-rc.4
TheInvarianttype definition link now uses thev0.53.0-rc.4tag.
61-61: Updated code reference URL to v0.53.0-rc.4
TheRegisterInvariantsexample in the staking module keeper now points tov0.53.0-rc.4.
64-64: Updated example link to v0.53.0-rc.4
The inline "For more, see" staking invariants link was updated tov0.53.0-rc.4.
73-73: Updated code reference URL to v0.53.0-rc.4
TheInvariantRegistryinterface link now uses thev0.53.0-rc.4tag.
79-79: Updated code reference URL to v0.53.0-rc.4
The crisis module keeper reference has been updated tov0.53.0-rc.4.docs/docs/learn/advanced/00-baseapp.md (2)
121-121: Updated code reference URL to v0.53.0-rc.4
The link tobaseapp/options.gounder theoptionssection now correctly points tov0.53.0-rc.4.
221-221: Updated code reference URL to v0.53.0-rc.4
The documentation for the defaultmsgServiceRouterlink now points tov0.53.0-rc.4.docs/docs/learn/advanced/07-cli.md (4)
46-46: Updated code reference URL to v0.53.0-rc.4
The examplemain.gofunction link now points to thev0.53.0-rc.4release.
62-62: Updated code reference URL to v0.53.0-rc.4
The "Learn more" server package link now points tov0.53.0-rc.4.
69-69: Updated code reference URL to v0.53.0-rc.4
Theroot_v2.goroot command example link was updated tov0.53.0-rc.4.
80-80: Updated code reference URL to v0.53.0-rc.4
TheinitAppConfig()override example now points to thev0.53.0-rc.4branch.docs/docs/build/building-modules/15-depinject.md (10)
33-33: Documentation reference updated to v0.53.0-rc.4
The Protobuf module configuration link now points tov0.53.0-rc.4.
42-42: Documentation reference updated to v0.53.0-rc.4
Theapp_config.gosnippet link now uses thev0.53.0-rc.4tag.
45-45: Documentation reference updated to v0.53.0-rc.4
Thepulsarscript link was updated to thev0.53.0-rc.4release.
46-46: Documentation reference updated to v0.53.0-rc.4
The generated Go code path for thegroupmodule now points tov0.53.0-rc.4.
70-70: Documentation reference updated to v0.53.0-rc.4
Themodule.goimport snippet link now refers tov0.53.0-rc.4.
77-77: Documentation reference updated to v0.53.0-rc.4
Theinit()wiring example link was updated tov0.53.0-rc.4.
95-95: Documentation reference updated to v0.53.0-rc.4
Thedepinject.Ininputs example now points tov0.53.0-rc.4.
102-102: Documentation reference updated to v0.53.0-rc.4
Thedepinject.Outoutputs example link has been updated tov0.53.0-rc.4.
108-108: Documentation reference updated to v0.53.0-rc.4
TheProvideModulefunction link now points tov0.53.0-rc.4.
117-117: Documentation reference updated to v0.53.0-rc.4
The complete module wiring configuration snippet link now uses thev0.53.0-rc.4tag.docs/docs/learn/advanced/04-store.md (1)
66-66: Consistent version update for store code references
All code reference URLs have been correctly updated fromv0.50.*tov0.53.0-rc.4, ensuring uniform versioning across the store documentation.Also applies to: 72-72, 82-82, 88-88, 102-102, 112-112, 125-125, 128-128, 144-144, 158-158, 174-174, 184-184, 192-192, 208-208, 230-230, 236-236, 242-242, 249-249, 257-257, 267-267, 281-281
docs/docs/build/building-modules/16-testing.md (1)
22-22: Consistent version update for testing documentation
All example links and scripts in the testing guide have been updated fromv0.50.*tov0.53.0-rc.4, aligning the testing module documentation with the latest SDK release candidate.Also applies to: 29-29, 34-34, 40-40, 46-46, 52-52, 84-84, 98-98, 102-102
docs/docs/build/building-modules/06-keeper.md (1)
44-44: Consistent version update for keeper documentation
The keeper example URLs for staking and auth modules have been updated tov0.53.0-rc.4, maintaining consistency in version references.Also applies to: 84-84, 91-91
docs/docs/build/building-modules/06-beginblock-endblock.md (1)
38-38: Consistent version update for BeginBlocker/EndBlocker examples
The example links forBeginBlocker(distribution) andEndBlocker(staking) have been updated tov0.53.0-rc.4, ensuring documentation consistency.Also applies to: 44-44
docs/docs/build/building-modules/03-msg-services.md (6)
27-27: Approve updated code reference link to v0.53.0-rc.4.
The exampleMsgServerinterface link now correctly points tov0.53.0-rc.4.
33-33: Approve updated code reference link to v0.53.0-rc.4.
Themsg_server.goimplementation link has been updated to the new release candidate.
39-39: Approve updated code reference link to v0.53.0-rc.4.
Thesdk.UnwrapSDKContextusage link now points to the correct version.
98-98: Approve updated code reference link to v0.53.0-rc.4.
TheWrapServiceResultwrapper link is updated to the new release candidate.
104-104: Approve updated protobuf reference link to v0.53.0-rc.4.
The ABCI protobuf definitions link now references the updated version.
118-118: Approve updated telemetry example link to v0.53.0-rc.4.
The vesting telemetry code reference has been bumped to RC4.docs/docs/build/building-modules/01-module-manager.md (16)
64-64: Approve updatedAppModuleBasicinterface link to v0.53.0-rc.4.
The code reference now correctly points to the new version.
76-76: Approve updatedHasNameinterface link to v0.53.0-rc.4.
TheHasNamesnippet URL has been bumped to the RC4 release.
142-142: Approve updatedAppModulelegacy interface link to v0.53.0-rc.4.
The legacymodule.AppModulereference now targets the correct version.
150-150: Approve updatedHasInvariantsinterface link to v0.53.0-rc.4.
The invariants registration snippet points to the updated SDK.
168-168: Approve updatedHasServicesinterface link to v0.53.0-rc.4.
The service registration reference URL is now correct.
178-178: Approve updatedHasConsensusVersionlink to v0.53.0-rc.4.
The consensus version method example now references RC4.
192-192: Approve updatedHasBeginBlockerinterface link to v0.53.0-rc.4.
TheBeginBlockersnippet URL is correctly updated.
202-202: Approve updatedHasEndBlockerinterface link to v0.53.0-rc.4.
TheEndBlockercode reference now matches the new release.
212-212: Approve updatedHasABCIEndBlocklink to v0.53.0-rc.4.
The ABCI end block interface example URL is updated.
222-222: Approve updatedHasPrecommitinterface link to v0.53.0-rc.4.
The precommit interface reference now points to RC4.
232-232: Approve updatedHasPrepareCheckStatelink to v0.53.0-rc.4.
The prepare-check-state interface snippet URL has been updated.
268-268: Approve updatedBasicManagerimplementation link to v0.53.0-rc.4.
The basic manager example now references the new version.
288-288: Approve updatedManagerimplementation link to v0.53.0-rc.4.
The manager code reference is correctly bumped.
317-317: Approve updatedsimappintegration link to v0.53.0-rc.4.
Thesimapp/app.goexample now points to RC4.
323-323: Approve updatedruntimemodule link (part 1) to v0.53.0-rc.4.
The runtime module example is updated to the correct version.
327-327: Approve updatedruntimemodule link (part 2) to v0.53.0-rc.4.
The second runtime example URL is now correct.
There was a problem hiding this comment.
some of these line-specific links are now shifted and point to the wrong things.
for example this line was changed:
https://github.com/cosmos/cosmos-sdk/blob/v0.50.0-alpha.0/types/module/module.go#L267-L276
to this:
https://github.com/cosmos/cosmos-sdk/blob/v0.53.0-rc.4/types/module/module.go#L267-L276
and now they highlight different types
Closes SDK-286
Summary by CodeRabbit