Skip to content
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: fix: escape mod reference #23418

Merged
merged 2 commits into from
Jan 16, 2025

Conversation

olliegilbey
Copy link
Contributor

@olliegilbey olliegilbey commented Jan 16, 2025

This commit wraps a path in the docs in backticks. The path breaks JSX on the unified docsite as it is read as an open tag with no closing.


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...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers 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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Release Notes: Cosmos SDK v0.52 Upgrade

  • Breaking Changes

    • Significant modifications to module management and initialization
    • Updated method signatures across various modules
    • Removal of x/params and x/crisis modules
    • Replacement of vesting accounts with x/accounts module
  • New Features

    • Introduction of unordered transactions
    • Added x/validate module for ante/post handlers
    • New account numbering system
  • Migration Requirements

    • Refactor module imports to cosmossdk.io/x/...
    • Update genesis interfaces
    • Migrate to new core API interfaces
    • Adapt to changes in server startup and configuration

This commit wraps a path in the docs in backticks.
The path breaks JSX on the unified docsite as it is read as an open tag
<mod> with no closing.
@olliegilbey olliegilbey requested a review from a team as a code owner January 16, 2025 15:07
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

📝 Walkthrough

Walkthrough

The document provides a comprehensive upgrade guide for transitioning from Cosmos SDK v0.50 to v0.52. It details significant architectural and functional changes, including the removal of the x/params module, elimination of the basic module manager, and introduction of new features like unordered transactions and the x/validate module. The guide emphasizes the need to refactor module imports, adopt core API interfaces, and update method signatures to align with the new SDK structure.

Changes

File Change Summary
x/{module_name}/module.go - Updated method signatures for InitGenesis and ExportGenesis to use context.Context instead of sdk.Context
- Replaced AppModuleBasic methods with AppModule methods for interface registration
x/gov/module.go - Updated ProposalHandler to use context.Context instead of sdk.Context

Possibly related issues

Possibly related PRs

Suggested labels

T:Docs, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • akhilkumarpilli

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 (4)
docs/build/building-apps/upgrades/0.52.md (4)

216-216: Fix typo in module import statement documentation.

The line contains a typo that affects readability.

-All modules except auth have been split into their own go.mod and are imported via `cosmossdk.io/x/<mod>`.
+All modules except auth have been split into their own go.mod and are imported via `cosmossdk.io/x/<module>`.

Line range hint 383-383: Fix typo in protocol pool description.

There's a spelling error in the word "fot".

-This new module allows teams and the community to create funding opportunities fot the development team and the community.
+This new module allows teams and the community to create funding opportunities for the development team and the community.

Line range hint 4-24: Add version compatibility information.

The introduction should explicitly state the minimum Go version required for v0.52 and any other critical dependencies to help users prepare for the upgrade.

Add a "Requirements" section under Prerequisites that includes:

  • Minimum Go version
  • CometBFT version compatibility range
  • Any other critical dependency versions

216-219: Improve module import migration clarity.

The module import migration instructions could be clearer with a complete example showing multiple imports.

Add a more comprehensive example:

import (
-    "github.com/cosmos/cosmos-sdk/x/auth"
-    "github.com/cosmos/cosmos-sdk/x/bank"
-    "github.com/cosmos/cosmos-sdk/x/gov"
+    "github.com/cosmos/cosmos-sdk/x/auth"  // auth remains in cosmos-sdk
+    "cosmossdk.io/x/bank"                  // moved to cosmossdk.io
+    "cosmossdk.io/x/gov"                   // moved to cosmossdk.io
)
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85682ac and d32ad93.

📒 Files selected for processing (1)
  • docs/build/building-apps/upgrades/0.52.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/upgrades/0.52.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 GitHub Actions: Spell Check
docs/build/building-apps/upgrades/0.52.md

[warning] 383-383: Spelling error: 'fot' should be one of: for, fit, dot, rot, cot, got, tot, fog

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: repo-analysis
  • GitHub Check: build (arm64)
  • GitHub Check: build (amd64)
  • GitHub Check: markdown-link-check
  • GitHub Check: dependency-review
  • GitHub Check: Summary

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 16, 2025
@aljo242 aljo242 enabled auto-merge January 16, 2025 18:59
@aljo242 aljo242 added this pull request to the merge queue Jan 16, 2025
Merged via the queue into cosmos:main with commit 77d4359 Jan 16, 2025
68 of 69 checks passed
mergify bot pushed a commit that referenced this pull request Jan 16, 2025
Co-authored-by: Alex | Interchain Labs <alex@skip.money>
(cherry picked from commit 77d4359)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants