-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update collections api example code link #23251
Conversation
📝 WalkthroughWalkthroughThis pull request involves updating usage references in the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/architecture/adr-062-collections-state-layer.md (1)
81-81
: Fix markdown list style inconsistency.The unordered list uses a dash (-) while other lists in the document use asterisks (*). For consistency, update the list marker.
-usage in nibiru: [x/oracle](https://github.com/NibiruChain/nibiru/blob/v2.0.0-rc.14/x/oracle/keeper/keeper.go#L37~L50), [x/epoch](https://github.com/NibiruChain/nibiru/blob/4566d9f6d22807abbd78c01454664d64f6e108e0/x/epochs/keeper/epoch.go) +* usage in nibiru: [x/oracle](https://github.com/NibiruChain/nibiru/blob/v2.0.0-rc.14/x/oracle/keeper/keeper.go#L37~L50), [x/epoch](https://github.com/NibiruChain/nibiru/blob/4566d9f6d22807abbd78c01454664d64f6e108e0/x/epochs/keeper/epoch.go)🧰 Tools
🪛 Markdownlint (0.37.0)
81-81: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/architecture/adr-062-collections-state-layer.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-062-collections-state-layer.md (1)
Pattern **/*.md
: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 Markdownlint (0.37.0)
docs/architecture/adr-062-collections-state-layer.md
81-81: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: dependency-review
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (1)
docs/architecture/adr-062-collections-state-layer.md (1)
81-81
: Verify the updated link and line range.The link has been updated to use a versioned tag instead of master, which is a good practice. Let's verify the link and line range accuracy.
✅ Verification successful
Link and line range are accurate
The referenced code section at lines 37-50 in the keeper.go file correctly demonstrates the collections usage pattern, showing various implementations of collections.Map, Item, KeySet, and Sequence.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the updated link points to valid code and line range # Test 1: Check if the tag exists gh api repos/NibiruChain/nibiru/git/refs/tags/v2.0.0-rc.14 # Test 2: Fetch the file content at the specified version and verify line range gh api repos/NibiruChain/nibiru/contents/x/oracle/keeper/keeper.go?ref=v2.0.0-rc.14 | jq -r '.content' | base64 -d | sed -n '37,50p'Length of output: 641
Script:
#!/bin/bash # Fetch the raw content directly and verify line range curl -s "https://raw.githubusercontent.com/NibiruChain/nibiru/v2.0.0-rc.14/x/oracle/keeper/keeper.go" | sed -n '37,50p'Length of output: 898
🧰 Tools
🪛 Markdownlint (0.37.0)
81-81: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Collections API examplesin nibiru
code link
I find another invalid link, similar to #23230
The old link
https://github.com/NibiruChain/nibiru/blob/master/x/oracle/keeper/keeper.go#L32
isn't correct and doesn't use versioned/tagged link, this PR updates it to the correct oneSummary by CodeRabbit
x/oracle
module to point to specific version tagx/epoch
module