-
Notifications
You must be signed in to change notification settings - Fork 4.1k
docs: replace dead reference #25044
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: replace dead reference #25044
Conversation
📝 WalkthroughWalkthroughThis change updates multiple documentation comments and URLs across several files to reference the correct, canonical, or updated locations—primarily removing version segments (such as Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (7)
🧰 Additional context used🧬 Code Graph Analysis (1)baseapp/abci.go (2)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (8)
✨ Finishing Touches
🧪 Generate unit tests
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 (
|
📝 WalkthroughWalkthroughThis change updates various documentation and comment URLs across multiple files, correcting branch references, line numbers, and path segments to point to the current or correct locations in external repositories and documentation. No code logic, functionality, or exported entities were modified; all changes are limited to comments and documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches
🧪 Generate unit tests
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 (
|
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)
x/gov/client/utils/query.go (1)
16-16: Pagination doc link corrected; optional improvementThe reference now matches the current CometBFT RPC docs – thanks.
As a minor follow-up, consider pointing to the stable docs site (https://docs.cometbft.com/...) rather than a branch path to avoid future line-number drift.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (7)
baseapp/abci.go(4 hunks)baseapp/abci_utils.go(1 hunks)crypto/keys/ed25519/doc.go(1 hunks)docs/docs/learn/advanced/00-baseapp.md(2 hunks)docs/src/css/custom.css(1 hunks)types/staking.go(1 hunks)x/gov/client/utils/query.go(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Summary
🔇 Additional comments (6)
types/staking.go (1)
15-15: Updated CometBFT ABCI++ spec link – LGTMThe new un-versioned URL is clearer and less likely to break when the repo is tagged again.
baseapp/abci_utils.go (1)
159-159: Anchor line updated – looks goodThe commit-pinned link keeps the reference reproducible; no further action needed.
crypto/keys/ed25519/doc.go (1)
7-7: Doc URL fixed – LGTM
The link now targets the currentmainbranch at the correct line number.docs/src/css/custom.css (1)
2-2: Reference branch switched tomain– LGTM
Keeps the comment in sync with upstream.docs/docs/learn/advanced/00-baseapp.md (1)
169-169: Verify the anchor-less URL still lands on the intended “custom mempool handlers” sectionThe old links pointed directly at the
#custom-mempool-handlersanchor; the new ones drop the anchor and shorten the path. Please make sure the rendered docs still scroll to (or clearly expose) that section—otherwise readers will have to search manually.Also applies to: 180-180
baseapp/abci.go (1)
289-293: Comment-only changes look goodAll modified lines update stale branch-specific URLs to
main, improving future-proofing without touching executable code. No further action required.Also applies to: 392-393, 412-413, 471-472, 478-479
📝 WalkthroughWalkthroughThis change updates various documentation and comment URLs across multiple files to reference current or correct locations, primarily by removing versioned path segments or correcting line numbers. No functional code, logic, or exported entities are modified; all updates are limited to comments and documentation links. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches
🧪 Generate unit tests
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 (
|
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 (2)
crypto/keys/ed25519/doc.go (1)
6-8: Prefer permalinks for long-lived referencesLinking to a line in the
mainbranch is brittle—any upstream change will shift the line numbers and break the reference. Consider switching to a permalink that targets a commit SHA (or drop the#Lxxxsuffix altogether) to minimise future link-rot.baseapp/abci.go (1)
288-293: Use commit permalinks instead ofmainbranch with line anchorsThe updated URL now points to
.../blob/main/statesync/syncer.go#L…. Line-anchored links againstmaintend to drift as the file evolves, leaving stale references.
Two safer options:-// https://github.com/cometbft/cometbft/blob/main/statesync/syncer.go#LXX +// https://github.com/cometbft/cometbft/blob/<commit-sha>/statesync/syncer.go#LXX // stable +// or simply drop the line fragment: +// https://github.com/cometbft/cometbft/blob/main/statesync/syncer.go // less brittleEither keeps the documentation useful longer-term.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting
📒 Files selected for processing (7)
baseapp/abci.go(4 hunks)baseapp/abci_utils.go(1 hunks)crypto/keys/ed25519/doc.go(1 hunks)docs/docs/learn/advanced/00-baseapp.md(2 hunks)docs/src/css/custom.css(1 hunks)types/staking.go(1 hunks)x/gov/client/utils/query.go(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
baseapp/abci.go (2)
baseapp/baseapp.go (1)
BaseApp(64-171)types/abci.go (1)
ProcessProposalHandler(33-33)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Summary
🔇 Additional comments (6)
docs/src/css/custom.css (1)
2-2: URL reference updated correctlySwitching from
developtomainmatches the current default branch in ignite/cli. No further action needed.types/staking.go (1)
15-15: 👍 Link drift fixedThe comment now points at the canonical path without the stale
/v2/segment—keeps docs from rotting.x/gov/client/utils/query.go (1)
16-16: Minor doc link cleanup looks goodRemoving the misplaced
/v2/segment avoids a 404. No code impact.docs/docs/learn/advanced/00-baseapp.md (2)
169-169: Docs point to relocated mempool sectionLink now follows the new IA (
build/…/app-mempool). Verified path exists in docs site. ✅
180-180: Consistent link updateSecond occurrence fixed to the same target—keeps readers on the right page.
baseapp/abci_utils.go (1)
159-160: Comment link re-synced with upstreamThe updated line number aligns with the current validator_set.go. Safe change.
|
aljo242 hey, are the CLI errors somehow related to me? thanks |
|
needs to be higher impact |
Description
Summary by CodeRabbit