docs: move invalid v20 breaking changes #2986
Conversation
lumtis
requested review from
brewmaster012,
kingpinXD,
ws4charlie,
skosito,
swift1337 and
fbac
as code owners
📝 WalkthroughWalkthroughThe changes documented in Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant EmissionsModule
participant ChainInfo
User->>EmissionsModule: Query fixed block reward (/zeta-chain/emissions/params)
EmissionsModule-->>User: Return fixed block reward amount
User->>ChainInfo: Update chain info (JSON file)
ChainInfo-->>User: Confirm chain info updated or added
User->>ChainInfo: Remove chain (chain-id)
ChainInfo-->>User: Confirm chain removed
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
|
![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
🧹 Outside diff range and nitpick comments (2)
docs/releases/v21_breaking_changes.md (2)
Line range hint
3-12: Consider emphasizing the new transaction type.The information provided about the refactoring of
update_chain_infoand the introduction ofRemoveChainInfois clear and concise. To further improve clarity, consider emphasizing the addition of the new transaction type.Suggestion:
# V21 Breaking Changes ### Update chain info refactored + +#### New transaction type: `RemoveChainInfo` * The `update_chain_info` message has been refactored to update/add a single chain ,instead of providing the entire list as `ChainInfo` * The user is now required to provide a json file with the details of the chain to be updated/added. * If the chain already exists, the details will be updated. * If the chain does not exist, it will be added to the list of chains and saved to the store. * A new transaction type `RemoveChainInfo` has also been added to remove a chain from the list of chains. * It accepts the chain-id of the chain to be removed as a parameter.This change highlights the introduction of the new transaction type, making it more prominent for users reviewing the breaking changes.
🧰 Tools
🪛 Markdownlint
16-16: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
17-17: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
13-18: Adjust list formatting for consistency.The information provided about the deprecation of
EmissionsFactorsis clear and concise. However, there's a minor formatting inconsistency in the unordered list.To address the Markdownlint hints and improve consistency, apply the following changes:
### Emissions factors deprecated * `EmissionsFactors` have been deprecated and removed from the `emissions` module. - - This results in the removal of the query `/zeta-chain/emissions/get_emissions_factors`. - - The fixed block reward amount can now be queried via `/zeta-chain/emissions/params`. This is constant for every block and does not depend on any factors. + * This results in the removal of the query `/zeta-chain/emissions/get_emissions_factors`. + * The fixed block reward amount can now be queried via `/zeta-chain/emissions/params`. This is constant for every block and does not depend on any factors.This change ensures consistent use of asterisks for all levels of the unordered list, improving the overall document formatting.
🧰 Tools
🪛 Markdownlint
16-16: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
17-17: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- docs/releases/v20_breaking_changes.md (0 hunks)
- docs/releases/v21_breaking_changes.md (1 hunks)
💤 Files with no reviewable changes (1)
- docs/releases/v20_breaking_changes.md
🧰 Additional context used
🪛 Markdownlint
docs/releases/v21_breaking_changes.md
16-16: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
17-17: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
🔇 Additional comments (2)
docs/releases/v21_breaking_changes.md (2)
Line range hint
1-3: Document structure and title are appropriate.The document is well-structured with a clear title and proper use of markdown headers for main sections. This organization enhances readability and aligns with the PR objectives.
🧰 Tools
🪛 Markdownlint
16-16: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
17-17: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Line range hint
1-18: Document effectively communicates V21 breaking changes.The document successfully outlines the breaking changes for version 21, including the refactoring of
update_chain_info, the introduction ofRemoveChainInfo, and the deprecation ofEmissionsFactors. The content is clear, concise, and aligns well with the PR objectives.The minor formatting suggestions provided earlier will further enhance the document's readability and consistency. Overall, this documentation update effectively informs users about the significant changes in this version.
🧰 Tools
🪛 Markdownlint
16-16: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
17-17: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Description
The change was not shipped in v20
Summary by CodeRabbit
New Features
Breaking Changes