docs: update version references #23898
Conversation
📝 WalkthroughWalkthroughThis pull request updates version references in several documentation files. Changes update URLs and version numbers from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
![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 (1)
x/group/internal/orm/README.md (1)
124-124: Consider Revising for Clarity
The sentence:
"Secondary indexes rely on anindexIteratorthat can strip theRowIDfrom the full index key in order to get the underlying value in the table prefix store."
might be simplified for improved readability. For example, consider:"Secondary indexes use an
indexIteratorto extract theRowIDfrom the full index key and retrieve the corresponding value from the prefix store."🧰 Tools
🪛 LanguageTool
[style] ~124-~124: Consider a shorter alternative to avoid wordiness.
Context: ...rip theRowIDfrom the full index key in order to get the underlying value in the table p...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
UPGRADING.md(1 hunks)depinject/README.md(1 hunks)depinject/appconfig/README.md(1 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)
✅ Files skipped from review due to trivial changes (7)
- depinject/appconfig/README.md
- depinject/README.md
- x/auth/vesting/README.md
- UPGRADING.md
- x/auth/tx/README.md
- x/evidence/README.md
- x/group/README.md
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
x/group/internal/orm/README.md
🪛 LanguageTool
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)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: repo-analysis
- GitHub Check: main
- GitHub Check: Check up to date mocks
- GitHub Check: build (arm64)
- GitHub Check: runtime-v2
- GitHub Check: build (amd64)
- GitHub Check: Summary
🔇 Additional comments (11)
x/group/internal/orm/README.md (11)
24-25: Updated URL for Table Reference
The URL now points to the correct version (v0.50.0) of the table implementation. This update correctly reflects the documentation change required.
45-46: Updated URL for AutoUInt64Table Reference
The URL for theAutoUInt64Tablehas been updated tov0.50.0and accurately references the intended code lines.
59-60: Updated URL for PrimaryKeyed Reference
The URL now correctly points to thePrimaryKeyedimplementation in the new version (v0.50.0). It is consistent with the overall update across the documentation.
78-79: Updated URL for Secondary Index in Types
The URL reference to the secondary index intypes.go(lines L88-L93) is updated tov0.50.0as required. The update is clear and correct.
86-87: Updated URL for MultiKeyIndex Reference
The link now correctly references the multi-key index implementation (index.goL26-L32) at versionv0.50.0.
92-93: Updated URL for MultiKeyIndex Details
The URL for the additional multi-key index details (lines L15-L20) has been updated tov0.50.0and is consistent with the other changes.
96-97: Updated URL for Indexer Reference
The URL for the indexer implementation (indexer.goL15-L19) is updated tov0.50.0, ensuring that users are directed to the correct version.
115-116: Updated URL for Iterator Implementation in Types
The URL referencing the iterator implementation intypes.go(lines L77-L85) now reflects the new versionv0.50.0accurately.
121-122: Updated URL for Table Iterator Reference
The URL for the table iterator (table.goL287-L291) has been updated tov0.50.0and is correct.
127-128: Updated URL for Index Iterator Reference
The URL pointing to the index iterator details (index.goL233-L239) is updated to versionv0.50.0and is consistent with the documentation updates.
138-139: Updated URL for Iterator in Iterator.go
The URL for the iterator implementation (iterator.goL102-L220) now usesv0.50.0, ensuring the documentation directs users to the most current version.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
x/group/internal/orm/README.md (1)
124-124: Consider Simplifying Wording
The sentence describing theindexIteratoron line 124 is somewhat wordy. Consider rephrasing for clarity—for example:
"Secondary indexes use anindexIteratorto extract the underlying table prefix value from theRowID."🧰 Tools
🪛 LanguageTool
[style] ~124-~124: Consider a shorter alternative to avoid wordiness.
Context: ...rip theRowIDfrom the full index key in order to get the underlying value in the table p...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
UPGRADING.md(1 hunks)depinject/README.md(1 hunks)depinject/appconfig/README.md(1 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)
🚧 Files skipped from review as they are similar to previous changes (7)
- depinject/README.md
- depinject/appconfig/README.md
- x/auth/vesting/README.md
- UPGRADING.md
- x/evidence/README.md
- x/auth/tx/README.md
- x/group/README.md
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
x/group/internal/orm/README.md
🪛 LanguageTool
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)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: Summary
🔇 Additional comments (11)
x/group/internal/orm/README.md (11)
24-24: Table Reference URL Update Verification
The URL for thetablereference has been updated tov0.50.xand now points totable.go#L30-L36. Please verify that this updated link accurately reflects the intended source code region.
45-45: AutoUInt64Table URL Updated
The link forAutoUInt64Tablenow correctly points to versionv0.50.xinauto_uint64.go#L15-L18. Ensure the referenced code lines match the expected content.
59-59: PrimaryKeyed Interface Reference Update
The URL for thePrimaryKeyTable’sPrimaryKeyedinterface has been updated tov0.50.x(linesL30-L44). Please confirm that the link directs readers to the complete and correct context.
78-78: Secondary Index URL Update
The URL in the secondary index section now targets versionv0.50.xintypes.go#L88-L93. This change aligns with the PR objective; please verify its accuracy.
86-86: MultiKeyIndex URL Update
The URL for theMultiKeyIndexsection has been updated to point to versionv0.50.x(linesL26-L32). The reference appears correct—please double-check its functionality.
92-92: MultiKeyIndex Additional Reference Update
The subsequent URL update inindex.gonow covers linesL15-L20under versionv0.50.x. Please review that this link serves its intended purpose.
96-96: Indexer URL Update Verification
The URL for theIndexerinindexer.gohas been updated to versionv0.50.x(linesL15-L19). Confirm that the referenced section correctly documents the desired functionality.
115-115: Iterator Reference URL Confirmation
The updated URL for the iterator intypes.go(linesL77-L85) now points tov0.50.x. Verify that this link correctly corresponds to the intended iterator documentation.
121-121: Table Iterator URL Updated
The URL for the table’s iterator has been updated to versionv0.50.x(linesL287-L291intable.go). Please ensure it directs users to the appropriate source segment.
127-127: Index Iterator URL Update
The updated URL for the index iterator inindex.gonow reflects versionv0.50.x(linesL233-L239). Confirm that this link is both functional and accurate.
138-138: Pagination Iterator URL Update
The URL for the pagination iterator initerator.gohas been updated tov0.50.x(linesL102-L220). Please verify the correctness of this reference in the context of pagination.
(cherry picked from commit 5411e73) # Conflicts: # UPGRADING.md # x/evidence/README.md
Co-authored-by: plubber <[email protected]> Co-authored-by: Alex | Interchain Labs <[email protected]>
Description
Updates links from v0.47.0-rc1 to v0.50 to reflect the latest maintained version of the SDK. This change ensures that users are directed to the most up-to-date documentation and code references.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit