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: remove invariants #22136

Merged
merged 1 commit into from
Oct 6, 2024
Merged

Conversation

tutufen
Copy link
Contributor

@tutufen tutufen commented Oct 5, 2024

Description

Refer to #22126

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity and structure of the module management system in the Cosmos SDK.
    • Expanded sections on application module interfaces and their roles.
    • Clear distinction between current practices and legacy interfaces.
    • Detailed explanations of the Manager structure and its methods.
    • Added references to source code for improved traceability.

@tutufen tutufen requested a review from a team as a code owner October 5, 2024 14:57
Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the 01-module-manager.md documentation to improve clarity and structure regarding the Cosmos SDK module management system. Key updates include detailed descriptions of the AppModule interfaces and their roles, an expanded section on application module interfaces, and refined explanations of lifecycle methods. Additionally, new methods have been added to various interfaces to enhance module management capabilities, with clear distinctions made between current practices and legacy interfaces.

Changes

File Path Change Summary
docs/build/building-modules/01-module-manager.md Significant updates to enhance clarity and structure regarding the Cosmos SDK module management system, including detailed descriptions of the AppModule interfaces and their roles, expanded sections on application module interfaces, and refined explanations of lifecycle methods.
- Interfaces Added methods to various interfaces: HasAminoCodec, HasRegisterInterfaces, HasGRPCGateway, module.HasGenesisBasics, HasBeginBlocker, HasEndBlocker, HasABCIEndBlock, HasServices, and HasConsensusVersion.

Possibly related PRs

  • docs: add instructions to change DefaultGenesis #21680: This PR discusses changes to the DefaultGenesis method, which is relevant as the main PR also includes updates to the DefaultGenesis method in the module.HasGenesisBasics interface.
  • docs: amend docs for 52 changes  #21992: This PR updates the documentation for BeginBlocker and EndBlocker, which aligns with the main PR's emphasis on the BeginBlock and EndBlock methods in the context of module management.
  • docs: remove invariants #22126: This PR focuses on removing the concept of invariants from the documentation, which is related to the main PR's updates on the AppModule interfaces and their management within the module system.
  • docs: pre,begin,end block #22127: This PR addresses documentation changes related to the PreBlocker, BeginBlocker, and EndBlocker, which are directly relevant to the main PR's updates on these lifecycle methods within the module management documentation.

Suggested labels

C:x/epochs, backport/v0.52.x

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • akhilkumarpilli

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 489aaae and facc131.

📒 Files selected for processing (1)
  • docs/build/building-modules/01-module-manager.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/build/building-modules/01-module-manager.md

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

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 5, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Oct 6, 2024
Merged via the queue into cosmos:main with commit 7ff7454 Oct 6, 2024
72 of 76 checks passed
mergify bot pushed a commit that referenced this pull request Oct 6, 2024
(cherry picked from commit 7ff7454)
akhilkumarpilli pushed a commit that referenced this pull request Oct 7, 2024
Co-authored-by: tutufen <tutufen@outlook.com>
@tutufen tutufen deleted the docs/remove-invariants branch October 8, 2024 00:09
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