chore: docs fixington #24711
chore: docs fixington #24711
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 |
github-actions
bot
added
C:x/staking
C:CLI
C:x/gov
C:x/slashing
C:x/distribution
📝 WalkthroughWalkthroughThe changes consist of systematic updates to documentation files across the repository, specifically targeting external links that reference source code in the Cosmos SDK GitHub repository. All affected links are updated to point to the stable Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant fix-links.py
participant Git
participant MarkdownFile
User->>fix-links.py: Run script (optionally with dry-run)
fix-links.py->>MarkdownFile: Scan for GitHub source links
loop For each link
fix-links.py->>Git: Fetch file at old version
fix-links.py->>Git: Fetch file at target version (v0.53.0)
fix-links.py->>fix-links.py: Fuzzy match line ranges
alt Match found
fix-links.py->>MarkdownFile: Update link with new version/line range
else No match
fix-links.py->>docs_todo.log: Log failure
end
end
fix-links.py->>User: Print summary/results
✨ Finishing Touches
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 2
🔭 Outside diff range comments (6)
x/mint/README.md (1)
97-98:⚠️ Potential issueStale protobuf link for Params section
The Params section still referencesv0.47.0-rc1. For consistency, update this link tov0.53.0, e.g.:- https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/mint/v1beta1/mint.proto#L26-L59 + https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/proto/cosmos/mint/v1beta1/mint.proto#L26-L59docs/docs/learn/advanced/06-grpc_rest.md (1)
81-81:⚠️ Potential issueInconsistent version in Swagger script link.
The Swagger generation script still points tov0.53.0-rc.2. To maintain consistency, update it tov0.53.0(e.g.,.../blob/v0.53.0/scripts/protoc-swagger-gen.sh).docs/docs/build/building-modules/07-invariants.md (1)
61-61:⚠️ Potential issueOutdated staking invariants link.
The example atx/staking/keeper/invariants.go#L12-L22still usesv0.50.0-alpha.0while others point tov0.53.0. Please update this link to the stablev0.53.0release.docs/docs/learn/advanced/05-encoding.md (1)
87-92:⚠️ Potential issueOutdated rc.2 links for auth tx module.
Thex/auth/tx/decoder.goandx/auth/tx/encoder.golinks still referencev0.53.0-rc.2. Update both tov0.53.0to align with other docs.docs/docs/learn/advanced/08-events.md (1)
145-145:⚠️ Potential issueInconsistent link: leftover release-candidate tag.
The legacy-events link still references
v0.53.0-rc.2instead of the stablev0.53.0tag.Apply this diff to correct the reference:
-[legacy events](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0-rc.2/x/bank/types/events.go) +[legacy events](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/bank/types/events.go)x/feegrant/README.md (1)
44-45:⚠️ Potential issueOutdated link detected: old release-candidate reference remains.
The Go reference for
FeeAllowanceIstill points tov0.47.0-rc1. This should be updated to the stablev0.53.0path (likelyx/feegrant/fees.goor its new location).
🧹 Nitpick comments (7)
docs/docs/learn/advanced/12-simulation.md (1)
54-54: Grammar nitpick: subject–verb agreement.
Change “The list of available parameters are listed [here]” to “The list of available parameters is listed [here]” for correctness.-The list of available parameters are listed [here](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/simulation/client/cli/flags.go#L72-L90). +The list of available parameters is listed [here](https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/simulation/client/cli/flags.go#L72-L90).🧰 Tools
🪛 LanguageTool
[grammar] ~54-~54: Possible agreement error.
Context: ...ed. The list of available parameters are listed [here](https://github.com/cosmos...(AGREEMENT_SENT_START)
docs/docs/learn/advanced/05-encoding.md (1)
151-151: Consistent phrasing: replace “Have a look at”.
Consider changing “Have a look at [a real-life example…]” to “Take a look at [a real-life example…]” for American English consistency.-Have a look at [a real-life example in the x/auth module](...#L291-L293). +Take a look at [a real-life example in the x/auth module](...#L291-L293).🧰 Tools
🪛 LanguageTool
[locale-violation] ~151-~151: In American English, “take a look” is more commonly used.
Context: ...face` method to bundle these two steps. Have a look at [a real-life example in the x/auth m...(HAVE_A_LOOK)
scripts/fix-links.py (5)
1-1: Add a she-bang to make the script directly executableIncluding an explicit she-bang (
#!/usr/bin/env python3) at the very top allows the script to be invoked as./fix-links.pyonce the executable bit is set, improving developer ergonomics and CI integration.+#!/usr/bin/env python3 import re import subprocess
70-75: Open files with an explicit UTF-8 encoding to avoid locale-dependent failuresRelying on the platform’s default encoding can break the script on systems whose locale is not UTF-8 (e.g. Windows with CP-1252). Explicitly specifying the encoding guarantees consistent behaviour across environments.
- with open(file_path, 'r') as f: + with open(file_path, 'r', encoding="utf-8") as f: content = f.read() … - with open(file_path, 'w') as f: + with open(file_path, 'w', encoding="utf-8") as f: f.write(new_content)Also applies to: 122-125
43-58: Pre-normalisenew_linesonce to avoid O(N²) work inside the sliding window
normalize_lines(window)is executed for every window, producing repeated string allocations and unnecessary regex calls. Normalisingnew_linesa single time outside the loop reduces the complexity from O(n·m) to O(n) where n islen(new_lines)and m isold_len.- best_score = 0.0 + new_norm_lines = normalize_lines(new_lines) + best_score = 0.0 best_range = None … - for i in range(len(new_lines) - old_len + 1): - window = new_lines[i:i + old_len] - window_str = "\n".join(normalize_lines(window)) + for i in range(len(new_norm_lines) - old_len + 1): + window = new_norm_lines[i:i + old_len] + window_str = "\n".join(window)
60-64: Gate verbose candidate printing behind a--verboseflagDumping the top-3 candidates for every link quickly becomes noisy when processing hundreds of files. Wrapping these diagnostics behind an optional flag keeps default output concise while preserving the invaluable debug information when needed.
- top_candidates = sorted(candidates, key=lambda x: -x[2])[:3] - for start, end, score in top_candidates: - print(f"🔎 Candidate range L{start}-L{end} scored {score:.2f}") + if '--verbose' in sys.argv: + top_candidates = sorted(candidates, key=lambda x: -x[2])[:3] + for start, end, score in top_candidates: + print(f"🔎 Candidate range L{start}-L{end} scored {score:.2f}")
23-29: Preserve text encoding when callinggit show
git showmay emit binary or non-UTF-8 data for certain files. Passingencoding="utf-8", errors="replace"preventsUnicodeDecodeErrors from crashing the script while still returning usable text for comparison.- result = subprocess.run( - ["git", "show", f"{version}:{filepath}"], - capture_output=True, - text=True, - check=True - ) + result = subprocess.run( + ["git", "show", f"{version}:{filepath}"], + capture_output=True, + text=True, + encoding="utf-8", + errors="replace", + check=True + )
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (38)
client/v2/README.md(1 hunks)collections/README.md(1 hunks)docs/DOC_WRITING_GUIDELINES.md(1 hunks)docs/architecture/adr-047-extend-upgrade-plan.md(1 hunks)docs/docs/build/abci/03-vote-extensions.md(1 hunks)docs/docs/build/building-apps/01-app-go-di.md(4 hunks)docs/docs/build/building-apps/04-vote-extensions.md(1 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/06-keeper.md(1 hunks)docs/docs/build/building-modules/07-invariants.md(2 hunks)docs/docs/build/building-modules/08-genesis.md(3 hunks)docs/docs/build/building-modules/09-module-interfaces.md(6 hunks)docs/docs/build/building-modules/12-errors.md(1 hunks)docs/docs/build/building-modules/13-upgrade.md(1 hunks)docs/docs/build/building-modules/14-simulator.md(7 hunks)docs/docs/build/building-modules/15-depinject.md(4 hunks)docs/docs/build/tooling/00-protobuf.md(3 hunks)docs/docs/learn/advanced/02-context.md(2 hunks)docs/docs/learn/advanced/05-encoding.md(5 hunks)docs/docs/learn/advanced/06-grpc_rest.md(2 hunks)docs/docs/learn/advanced/08-events.md(3 hunks)docs/docs/learn/advanced/11-runtx_middleware.md(1 hunks)docs/docs/learn/advanced/12-simulation.md(4 hunks)docs/docs/learn/beginner/04-gas-fees.md(2 hunks)scripts/fix-links.py(1 hunks)x/authz/README.md(9 hunks)x/bank/README.md(5 hunks)x/circuit/README.md(2 hunks)x/crisis/README.md(1 hunks)x/distribution/README.md(5 hunks)x/feegrant/README.md(7 hunks)x/genutil/README.md(1 hunks)x/gov/README.md(8 hunks)x/mint/README.md(1 hunks)x/slashing/README.md(2 hunks)x/staking/README.md(15 hunks)x/upgrade/README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
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)
docs/docs/build/building-modules/13-upgrade.md
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...esses to be prefixed by their length in bytes as outlined in [ADR-028](../architectur...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/learn/advanced/12-simulation.md
[grammar] ~54-~54: Possible agreement error.
Context: ...ed. The list of available parameters are listed [here](https://github.com/cosmos...
(AGREEMENT_SENT_START)
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/learn/advanced/05-encoding.md
[locale-violation] ~151-~151: In American English, “take a look” is more commonly used.
Context: ...face` method to bundle these two steps. Have a look at [a real-life example in the x/auth m...
(HAVE_A_LOOK)
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/14-simulator.md
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ... - HasWeightedOperationsXWithProposals: [x/gov](https://github.com/cosmos/cosmo...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: build (arm64)
- GitHub Check: Check up to date mocks
- GitHub Check: build (amd64)
- GitHub Check: dependency-review
- GitHub Check: Check docs build
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (128)
docs/docs/build/abci/03-vote-extensions.md (1)
38-38: Consistent external link update
The link tosdk.VerifyVoteExtensionHandlerhas been correctly updated to point to the stablev0.53.0release with the new line range.docs/docs/learn/advanced/11-runtx_middleware.md (1)
16-17: Updated recovery.go reference to stable release
The URL forrecovery.gois now accurately pointing tov0.53.0and the referenced lines L14–L17.docs/docs/build/building-modules/06-keeper.md (1)
44-44: Keeper type definition link updated
Thekeeper.goreference is correctly updated tov0.53.0targeting lines L24–L31, matching the stable release.x/mint/README.md (1)
86-86: Protobuf link for Minter updated to v0.53.0
Themint.protoreference for theMintermessage now correctly points tov0.53.0lines L10–L24.docs/docs/build/building-modules/12-errors.md (1)
46-46: Error wrapping example link updated
Thekeeper.goexample link for error wrapping has been updated tov0.53.0lines L122–L157 as intended.client/v2/README.md (1)
153-153: Update external reference to stable v0.53.0 release.
The GitHub link now points tov0.53.0/x/auth/autocli.go#L25-L30. Please verify that the file path and line numbers exist in thev0.53.0tag.docs/DOC_WRITING_GUIDELINES.md (1)
34-34: Link reference updated to v0.53.0.
The GitHub snippet link now points toserver/types/app.go#L68-L69on the stablev0.53.0tag. Looks consistent.docs/docs/build/building-modules/13-upgrade.md (1)
63-63: Update migration example link to v0.53.0.
The link tomigrateBalanceKeysnow targetsx/bank/migrations/v2/store.go#L55-L73onv0.53.0. Confirm the line range aligns with the updated migration code.🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...esses to be prefixed by their length in bytes as outlined in [ADR-028](../architectur...(AI_HYDRA_LEO_MISSING_COMMA)
x/circuit/README.md (2)
20-20: Updated message router check link to v0.53.0.
This link now points tobaseapp/msg_service_router.go#L104-L115on thev0.53.0tag. Ensure the code at this location still corresponds to the message router logic.
103-103: Refreshed protobuf link for MsgAuthorizeCircuitBreaker.
The reference now targetsproto/cosmos/circuit/v1/tx.proto#L36-L75onv0.53.0. Verify that the message definition and line numbers match in this version.docs/architecture/adr-047-extend-upgrade-plan.md (1)
22-22: Link updated to v0.53.0 for Plan message.
The hyperlink to thePlanprotobuf now points toproto/cosmos/upgrade/v1beta1/upgrade.proto#L14onv0.53.0. Please confirm the correct line location in the updated proto file.docs/docs/learn/advanced/02-context.md (2)
23-23: Updated Context definition reference link to stable tag
The reference now correctly points tov0.53.0intypes/context.gofor lines40-67, aligning with the stable release.
44-45: UpdatedCometInfoandHeaderInfolinks tov0.53.0
Both links now anchor to the stablev0.53.0tag incore/comet/service.goandcore/header/service.go, ensuring consistent, versioned references.docs/docs/build/building-modules/09-module-interfaces.md (3)
30-30: Updated transaction command example link tov0.53.0
The CLI transaction command example now references the stablev0.53.0tag inx/bank/client/cli/tx.go#L39-L72.
52-52: UpdatedNewTxCmdaggregation example link tov0.53.0
The example now points tox/bank/client/cli/tx.go#L22-L35at thev0.53.0tag, aligning with other updated references.
99-99: Updated CLI aggregation example link in module tov0.53.0
TheGetTxCmd()link now correctly targetsx/bank/module.go#L88-L90on thev0.53.0tag.docs/docs/build/building-apps/04-vote-extensions.md (1)
43-43: UpdatedVerifyVoteExtensionHandlerreference tov0.53.0
The link now points to the stablev0.53.0tag intypes/abci.go#L31-L32, ensuring a fixed reference to the handler definition.x/genutil/README.md (3)
22-22: Updated application genesis struct link tov0.53.0
The reference now correctly points tox/genutil/types/genesis.go#L27-L37on thev0.53.0tag.
28-28: Updated genesis-to-consensus translation link tov0.53.0
The link now anchors tox/genutil/types/genesis.go#L148-L158at thev0.53.0tag, aligning with the stable release.
32-32: Updated server start logic reference tov0.53.0
The example now targetsserver/start.go#L414-L423on thev0.53.0tag, ensuring consistency with other documentation links.x/crisis/README.md (1)
49-49: Correctly updated protobuf URL to v0.53.0
TheMsgVerifyInvariantprotobuf reference now points tov0.53.0with the adjustedL26-L38range as expected.x/upgrade/README.md (2)
106-106: Upgrade proposal protobuf link updated
TheMsgSoftwareUpgradereference now correctly targetsv0.53.0linesL28-L38intx.proto.
118-118: Cancel upgrade proposal link updated
TheMsgCancelUpgradereference now correctly targetsv0.53.0linesL46-L54intx.proto.x/bank/README.md (1)
134-134: Bank protobuf reference updated to v0.53.0
Thebank.protolink now points tov0.53.0andL11-L22, aligning with the updated SDK structure.docs/docs/build/tooling/00-protobuf.md (5)
14-14: Makefile reference updated to v0.53.0
TheMakefilelink now correctly points tov0.53.0linesL423-L438.
81-81: Clarified buf.gen.swagger.yaml description
The description forbuf.gen.swagger.yamlis now clearer and accurately explains its role in generating Swagger docs.
96-96: buf.lock reference updated to v0.53.0
Thebuf.lockfile link is now correctly pointing tov0.53.0linesL1-L16.
101-101: Updatedbuf.yamldescription context
The introductory text forbuf.yamlnow accurately reflects configuration fields in v0.53.0.
104-104: buf.yaml link updated to v0.53.0
Thebuf.yamlreference correctly points tov0.53.0atL3.x/slashing/README.md (2)
146-146: ValidatorSigningInfo protobuf link updated
TheValidatorSigningInforeference now points tov0.53.0linesL13-L34inslashing.proto.
157-157: Params protobuf link updated
TheParamsreference now points tov0.53.0linesL35-L56inslashing.proto.docs/docs/build/building-modules/08-genesis.md (5)
35-35: Stable link for DefaultGenesis updated correctly.
TheDefaultGenesis()reference now points tov0.53.0at#L61-L65. This aligns with the PR objective to use the stable release.
43-43: ValidateGenesis link updated to stable release.
TheValidateGenesisexample now links tov0.53.0attypes/genesis.go#L62-L73. Confirm the lines still match the current code.
59-59: InitGenesis reference updated to v0.53.0.
TheInitGenesisexample now points tox/auth/keeper/genesis.go#L8-L32onv0.53.0. Looks correct.
69-69: ExportGenesis link updated to stable tag.
TheExportGenesisexample now referencesx/auth/keeper/genesis.go#L36-L46onv0.53.0. Good.
77-77: GenesisTxHandler example updated.
TheGenesisTxHandlerlink now points tocore/genesis/txhandler.go#L3-L6onv0.53.0. This maintains consistency.docs/docs/learn/advanced/06-grpc_rest.md (2)
34-34: gRPC server hookup link updated to stable release.
The reference toserver/types/app.go#L46-L48now usesv0.53.0. Ensure the code lines still align.
69-69: REST route protobuf link updated.
Thequery.proto#L23-L30reference is correctly updated tov0.53.0.docs/docs/learn/advanced/12-simulation.md (3)
42-42: Simulation flags link updated to stable release.
The full list of flags now points tov0.53.0/x/simulation/client/cli/flags.go#L44-L69. Good.
64-64: Makefile example link updated.
The link toMakefile#L285-L314now referencesv0.53.0. Looks correct.
86-86: Logger example link updated.
Thekeeper.go#L77-L81link is now onv0.53.0. Confirm that the Keeper example still matches.docs/docs/build/building-modules/07-invariants.md (4)
22-22: Invariant type link updated to stable release.
Thetypes/invariant.go#L9reference now usesv0.53.0. Good.
73-73: InvariantRegistry interface link updated.
Thetypes/invariant.go#L14-L17link is correctly updated tov0.53.0.
79-79: Crisis keeper registry link updated.
Thex/crisis/keeper/keeper.go#L51-L53reference now points tov0.53.0.
87-87: End-of-block invariants example link updated.
Thex/crisis/abci.go#L12-L21link usesv0.53.0. Looks accurate.docs/docs/learn/advanced/05-encoding.md (4)
81-81: Transaction encoder/decoder import updated.
Thetx_msg.go#L112-L115link now points tov0.53.0. Confirm the code lines remain accurate.
195-195: Validator struct example updated.
The link tox/staking/types/staking.pb.go#L341-L375is now onv0.53.0. Looks correct.
200-200: PubKey encoding example updated.
Thex/staking/types/validator.go#L43-L64reference is correctly updated tov0.53.0.
222-230: Switch fromanypbtoanyutil.
The diff correctly replaces imports and calls to usegithub.com/cosmos/cosmos-proto/anyutil, ensuring the SDK’sAnyhandling remains consistent with v0.53.0.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
222-222: Hard tabs
Column: 3(MD010, no-hard-tabs)
223-223: Hard tabs
Column: 2(MD010, no-hard-tabs)
docs/docs/learn/advanced/08-events.md (3)
69-70: Validated stable tag update for EventManager reference.The Go reference link has been correctly updated to point to the
v0.53.0tag intypes/events.go.
77-78: Validated stable tag update for EmitTypedEvent reference.The Go reference link for the
EmitTypedEventmethod correctly targetsv0.53.0intypes/events.go.
128-128: Validated stable tag update for NFT event proto reference.The
event.protolink now correctly points tov0.53.0inproto/cosmos/nft/v1beta1/event.proto.docs/docs/build/building-modules/03-msg-services.md (6)
27-28: Validated update to stable tag for generated MsgServer interface.Link updated to
v0.53.0inx/bank/types/tx.pb.go#L538-L556.
33-34: Validated update to stable tag for Keeper-based msgServer struct.Link updated to
v0.53.0inx/bank/keeper/msg_server.go#L17-L19.
39-40: Validated update to stable tag for UnwrapSDKContext usage.Link updated to
v0.53.0inx/bank/keeper/msg_server.go#L56.
98-100: Validated update to stable tag for WrapServiceResult implementation.Link updated to
v0.53.0inbaseapp/msg_service_router.go#L208.
104-105: Validated update to stable tag for ABCI protobuf definitions.Link updated to
v0.53.0inproto/cosmos/base/abci/v1beta1/abci.proto#L90-L106.
118-119: Validated update to stable tag for telemetry example in vesting module.Link updated to
v0.53.0inx/auth/vesting/msg_server.go#L79-L90.x/distribution/README.md (5)
177-178: Validated update to stable tag for FeePool protobuf reference.Link now points to
v0.53.0inproto/cosmos/distribution/v1beta1/distribution.proto#L117-L124.
222-224: Validated update to stable tag for Params protobuf reference.Link now points to
v0.53.0inproto/cosmos/distribution/v1beta1/distribution.proto#L12-L38.
358-361: Validated update to stable tag for MsgSetWithdrawAddress response.Link now points to
v0.53.0inproto/cosmos/distribution/v1beta1/tx.proto#L60-L69.
410-412: Validated update to stable tag for MsgWithdrawDelegatorReward response.Link now points to
v0.53.0inproto/cosmos/distribution/v1beta1/tx.proto#L76-L85.
487-489: Validated update to stable tag for MsgUpdateParams protobuf reference.Link now points to
v0.53.0inproto/cosmos/distribution/v1beta1/tx.proto#L146-L158.x/feegrant/README.md (7)
37-39: Validated update to stable tag for FeeAllowance protobuf reference.Link updated to
v0.53.0inproto/cosmos/feegrant/v1beta1/feegrant.proto#L86-L94.
60-61: Validated update to stable tag for BasicAllowance protobuf reference.Link updated to
v0.53.0inproto/cosmos/feegrant/v1beta1/feegrant.proto#L13-L25.
74-75: Validated update to stable tag for PeriodicAllowance protobuf reference.Link updated to
v0.53.0inproto/cosmos/feegrant/v1beta1/feegrant.proto#L37-L66.
92-93: Validated update to stable tag for AllowedMsgAllowance protobuf reference.Link updated to
v0.53.0inproto/cosmos/feegrant/v1beta1/feegrant.proto#L72-L81.
104-105: Validated update to stable tag for client/cmd.go FeeGranter flag.Link updated to
v0.53.0inclient/cmd.go#L252-L261.
112-113: Validated update to stable tag for tx builder in auth module.Link updated to
v0.53.0inx/auth/tx/builder.go#L356-L363.
116-117: Validated update to stable tag for tx proto definitions.Link updated to
v0.53.0inproto/cosmos/tx/v1beta1/tx.proto#L221-L239.docs/docs/build/building-modules/02-messages-and-queries.md (3)
37-38: Validated update to stable tag for Msg service protobuf reference.Link updated to
v0.53.0inproto/cosmos/bank/v1beta1/tx.proto#L13-L32.
101-102: Validated update to stable tag for auth Query service protobuf reference.Link updated to
v0.53.0inproto/cosmos/auth/v1beta1/query.proto#L12-L78.
136-137: Validated update to stable tag for store queries reference.Link updated to
v0.53.0inbaseapp/abci.go#L1050-L1074.docs/docs/build/building-apps/01-app-go-di.md (6)
32-33: Updated GitHub reference to stable v0.53.0 forapp_config.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
38-39: Updated GitHub reference to stable v0.53.0 forapp_di.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
47-48: Updated GitHub reference to stable v0.53.0 forapp_config.goruntime configuration.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
55-56: Updated GitHub reference to stable v0.53.0 for module wiring inapp_config.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
61-62: Updated GitHub reference to stable v0.53.0 forapp_config.gotx wiring.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
114-115: Updated GitHub reference to stable v0.53.0 for completeapp_di.gosnippet.
The link now correctly points to thev0.53.0tag with adjusted line numbers.docs/docs/learn/beginner/04-gas-fees.md (3)
29-30: Updated GitHub reference to stable v0.53.0 forgas.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
87-88: Updated GitHub reference to stable v0.53.0 fortx_msg.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
93-94: Updated GitHub reference to stable v0.53.0 fortx.proto.
The link now correctly points to thev0.53.0tag with adjusted line numbers.docs/docs/build/building-modules/15-depinject.md (7)
42-43: Updated GitHub reference to stable v0.53.0 forapp_config.gosnippet.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
51-52: Updated GitHub reference to stable v0.53.0 for generated Pulsar code.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
70-71: Updated GitHub reference to stable v0.53.0 for module import inmodule.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
77-78: Updated GitHub reference to stable v0.53.0 forinitproviders inmodule.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
83-84: Updated GitHub reference to stable v0.53.0 forAppModuleinterface implementation.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
95-96: Updated GitHub reference to stable v0.53.0 for module input struct inmodule.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
102-103: Updated GitHub reference to stable v0.53.0 for module output struct inmodule.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.docs/docs/build/building-modules/14-simulator.md (8)
51-52: Updated GitHub reference to stable v0.53.0 forsimsx/runner.goL223–L234.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
59-59: Updated inline link to stable v0.53.0 forsimsx/runner.goL330–L339.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
65-67: Updated example implementation links to stable v0.53.0 for weighted operations and proposals.
All three list items now point to thev0.53.0tag with adjusted line numbers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ... -HasWeightedOperationsXWithProposals: [x/gov](https://github.com/cosmos/cosmo...(UNLIKELY_OPENING_PUNCTUATION)
76-76: Updated GitHub reference to stable v0.53.0 forx/bank/module.gostore decoders.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
115-115: Updated GitHub reference to stable v0.53.0 for distribution module message factories.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
139-139: Updated GitHub reference to stable v0.53.0 forsimapp/app.gosimulation manager setup.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
159-159: Updated GitHub reference to stable v0.53.0 forsimsx/runner.goL69–L88.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
175-175: Updated GitHub reference to stable v0.53.0 forsimapp/sim_test.goexample.
The link now correctly points to thev0.53.0tag with adjusted line numbers.x/authz/README.md (12)
44-44: Updated GitHub reference to stable v0.53.0 forauthorizations.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
56-56: Updated protobuf reference to stable v0.53.0 forauthz.protoGenericAuthorization.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
60-60: Updated Go reference to stable v0.53.0 forgeneric_authorization.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
73-73: Updated protobuf reference to stable v0.53.0 for SendAuthorization.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
77-77: Updated Go reference to stable v0.53.0 forsend_authorization.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
88-88: Updated protobuf reference to stable v0.53.0 forstakingmodule authz.proto.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
92-92: Updated Go reference to stable v0.53.0 forx/staking/types/authz.go.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
112-112: Updated protobuf reference to stable v0.53.0 forauthz.protoGrant.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
130-130: Updated Go reference to stable v0.53.0 forkeeper/keys.goGrantQueue.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
145-145: Updated protobuf reference to stable v0.53.0 fortx.protoMsgGrant.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
160-160: Updated protobuf reference to stable v0.53.0 fortx.protoMsgRevoke.
The link now correctly points to thev0.53.0tag with adjusted line numbers.
175-175: Updated protobuf reference to stable v0.53.0 fortx.protoMsgExec.
The link now correctly points to thev0.53.0tag with adjusted line numbers.x/staking/README.md (9)
97-97: Update protobuf reference forParamsto v0.53.0
The URL now correctly points tostaking.protoat v0.53.0, lines 296–318.
160-160: Update protobuf reference forValidatorstruct to v0.53.0
The link correctly reflectsstaking.protoin v0.53.0, lines 82–135.
164-164: Update protobuf reference forValidatorenum to v0.53.0
The URL accurately points tostaking.protov0.53.0, lines 29–78.
180-180: Update protobuf reference forDelegationto v0.53.0
Link updated tostaking.protov0.53.0, lines 191–208.
228-228: Update protobuf reference forUnbondingDelegationto v0.53.0
Correctly points tostaking.protov0.53.0, lines 210–249.
270-270: Update protobuf reference forRedelegationto v0.53.0
Now referencesstaking.protov0.53.0, lines 253–294.
294-294: Update protobuf reference forUnbondingDelegationQueueto v0.53.0
Link updated tostaking.protov0.53.0, lines 157–166.
305-305: Update protobuf reference forRedelegationQueueto v0.53.0
URL now points tostaking.protov0.53.0, lines 173–184.
326-326: Update go reference forHistoricalInfoto v0.53.0
The link correctly referencesstaking.protov0.53.0, lines 17–24.x/gov/README.md (10)
174-174: Update weighted vote protobuf reference to v0.53.0
Link now points togov.protoin v1beta1 at v0.53.0, lines 32–44.
178-178: Update weighted vote options protobuf reference to v0.53.0
Correctly referencesgov.protoin v1beta1 at v0.53.0, lines 178–195.
188-188: Update go reference for custom vote calculation to v0.53.0
Now links totally.gov0.53.0, lines 15–24.
327-327: Update protobuf reference forProposalto v1 in v0.53.0
Link correctly points togov.protov1 at v0.53.0, lines 50–86.
375-375: Update protobuf reference forDepositParamsto v0.53.0
URL now referencesgov.protov1 at v0.53.0, lines 160–169.
381-381: Update protobuf reference forVotingParamsto v0.53.0
Link updated togov.protov1 at v0.53.0, lines 172–176.
387-387: Update protobuf reference forTallyParamsto v0.53.0
Correctly points togov.protov1 at v0.53.0, lines 183–193.
556-556: Update tx reference forMsgSubmitProposalto v0.53.0
Link now points totx.protoin v1 at v0.53.0, lines 57–78.
586-586: Update tx reference forMsgDepositto v0.53.0
URL correctly referencestx.protov1 at v0.53.0, lines 155–165.
605-605: Update tx reference forMsgVoteto v0.53.0
Link updated totx.protov1 at v0.53.0, lines 111–123.
collections/README.md
Outdated
| @@ -90,7 +90,7 @@ Since a module can have multiple collections, the following is expected: | |||
| We don't want a collection to write over the state of the other collection so we pass it a prefix, which defines a storage | |||
| partition owned by the collection. | |||
|
|
|||
| If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.52.0-rc.1/x/feegrant/key.go#L16~L22 | |||
| If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/feegrant/key.go#L25~L22 | |||
There was a problem hiding this comment.
Invalid GitHub link syntax: reversed line range and tilde used
The example link uses #L25~L22, which is not a valid GitHub line range and the start/end lines appear reversed. It should use a hyphen and correct ordering, e.g.: #L22-L25.
Apply this diff to correct it:
- example: https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/feegrant/key.go#L25~L22
+ example: https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/feegrant/key.go#L22-L25📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/feegrant/key.go#L25~L22 | |
| If you already built modules, the prefix translates to the items you were creating in your ``types/keys.go`` file, example: https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/x/feegrant/key.go#L22-L25 |
🤖 Prompt for AI Agents (early access)
In collections/README.md at line 93, the GitHub link uses an invalid line range syntax with reversed line numbers and a tilde. Correct the link by replacing `#L25~L22` with a valid range using a hyphen and proper order, such as `#L22-L25`.
| https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/client/tx/tx.go#L109-L109 | ||
| ``` |
There was a problem hiding this comment.
Outdated link detected: old release-candidate reference remains.
The Go reference in client/tx/tx.go still points to v0.47.0-rc1. It should be updated to the corresponding v0.53.0 location.
🤖 Prompt for AI Agents (early access)
In x/feegrant/README.md around lines 108 to 109, update the outdated Go reference link from version v0.47.0-rc1 to the correct v0.53.0 version. Replace the old release-candidate URL with the stable release URL pointing to the same file path in the v0.53.0 tag.
aljo242
force-pushed
the
chore/docs-fixington
branch
from
783bee6 to
f2efc1e
Compare
| https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L78-L97 | ||
| https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/proto/cosmos/staking/v1beta1/tx.proto#L79-L95 |
| https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/staking/v1beta1/tx.proto#L154-L158 | ||
| https://github.com/cosmos/cosmos-sdk/blob/v0.53.0/proto/cosmos/staking/v1beta1/tx.proto#L154-L158 |
Closes: SDK-286
create epic script to automate doc fixing
Summary by CodeRabbit