fix/fix_broadcaster_note_formatting #177
Conversation
WalkthroughThe update applies a formatting adjustment to documentation related to the Transaction Broadcaster's gas cost estimation for the MsgBatchUpdateOrders message. It merges two explanatory sentences into a single continuous sentence and adds a trailing blank line, improving the flow of the note. There are no changes to logic, technical content, or code. Changes
Poem
🪧 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
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR resolves a text formatting error in the broadcaster section by consolidating fragmented information into a more cohesive note.
- Merged bullet‐point style details into a single paragraph
- Adjusted text to improve readability and consistency
Comments suppressed due to low confidence (2)
source/includes/_broadcaster.md:493
- Consider changing 'There an important consideration' to 'There is an important consideration' for grammatical correctness.
There an important consideration when using the Transaction Broadcaster calculating the gas cost without simulation to send a _MsgBatchUpdateOrders_ message.
source/includes/_broadcaster.md:494
- The word 'correclty' appears to be misspelled; consider using 'correctly'.
The logic that estimates the gas cost for the _MsgBatchUpdateOrders_ correclty calculates the gas required for each order action (creation or cancelation) it includes.
| By default the estimation logic calculates a gas cost considering the number of orders to cancel for each market id is 20. To improve the gas cost calculation when using the _MsgBatchUpdateOrders_ message to cancel all orders for one or more markets you can change the number of estimated orders to cancel per market. Check in the fine-tunning section the proper `AVERAGE_CANCEL_ALL_AFFECTED_ORDERS` global variable to change. | ||
|
|
There was a problem hiding this comment.
Consider correcting 'fine-tunning' to 'fine-tuning'.
| By default the estimation logic calculates a gas cost considering the number of orders to cancel for each market id is 20. To improve the gas cost calculation when using the _MsgBatchUpdateOrders_ message to cancel all orders for one or more markets you can change the number of estimated orders to cancel per market. Check in the fine-tunning section the proper `AVERAGE_CANCEL_ALL_AFFECTED_ORDERS` global variable to change. | |
| By default the estimation logic calculates a gas cost considering the number of orders to cancel for each market id is 20. To improve the gas cost calculation when using the _MsgBatchUpdateOrders_ message to cancel all orders for one or more markets you can change the number of estimated orders to cancel per market. Check in the fine-tuning section the proper `AVERAGE_CANCEL_ALL_AFFECTED_ORDERS` global variable to change. |
![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
🧹 Nitpick comments (1)
source/includes/_broadcaster.md (1)
493-495: Typographical & grammatical refinements.Please apply the following corrections to polish the note:
- There an important consideration when using the Transaction Broadcaster calculating the gas cost without simulation to send a _MsgBatchUpdateOrders_ message. + There is an important consideration when using the Transaction Broadcaster to calculate the gas cost without simulation for a _MsgBatchUpdateOrders_ message. - The logic that estimates the gas cost for the _MsgBatchUpdateOrders_ correclty calculates the gas required for each order action ... + The logic that estimates the gas cost for the _MsgBatchUpdateOrders_ correctly calculates the gas required for each order action ... - By default the estimation logic calculates a gas cost considering the number of orders ... + By default, the estimation logic calculates a gas cost considering the number of orders ... - Check in the fine-tunning section ... + Check in the fine‑tuning section ...🧰 Tools
🪛 LanguageTool
[uncategorized] ~494-~494: Did you mean: “By default,”?
Context: ...n the number of orders to be cancelled. By default the estimation logic calculates a gas c...(BY_DEFAULT_COMMA)
🪛 markdownlint-cli2 (0.17.2)
493-493: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
493-493: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/includes/_broadcaster.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/includes/_broadcaster.md
[uncategorized] ~492-~492: “There” seems less likely than “they’re”.
Context: ...lation`.
--- NOTE: There an important consideration when using t...
(AI_HYDRA_LEO_CP_THERE_THEYARE)
[uncategorized] ~494-~494: Did you mean: “By default,”?
Context: ...n the number of orders to be cancelled. By default the estimation logic calculates a gas c...
(BY_DEFAULT_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/includes/_broadcaster.md
493-493: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
493-493: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - injective-docs
- GitHub Check: Header rules - injective-docs
- GitHub Check: Pages changed - injective-docs
- GitHub Check: test (3.2)
🔇 Additional comments (1)
source/includes/_broadcaster.md (1)
491-496: Approve merging the explanatory sentences and blank‑line adjustment.The removal of the extra paragraph break and the addition of a trailing blank line improve the flow and readability of the note.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~492-~492: “There” seems less likely than “they’re”.
Context: ...lation`.
--- NOTE: There an important consideration when using t...(AI_HYDRA_LEO_CP_THERE_THEYARE)
[uncategorized] ~494-~494: Did you mean: “By default,”?
Context: ...n the number of orders to be cancelled. By default the estimation logic calculates a gas c...(BY_DEFAULT_COMMA)
🪛 markdownlint-cli2 (0.17.2)
493-493: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
493-493: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
494-494: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
495-495: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
Summary by CodeRabbit