(Feat) Added documentation for tendermint module queries #161
Conversation
WalkthroughThe recent updates bring a more organized and visually appealing documentation by introducing HTML line breaks between sections for clarity, especially for entities across various modules. Additionally, the Python SDK now supports all queries from the Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (29)
source/json_tables/chain/tendermint/abciQueryRequest.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/abciQueryResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/block.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/blockID.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/blockIDFlag.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/commit.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/commitSig.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/consensus.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/data.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/defaultNodeInfo.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/defaultNodeInfoOther.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/evidence.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/evidenceList.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getBlockByHeightRequest.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getBlockByHeightResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getLatestBlockResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getLatestValidatorSetResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getNodeInfoResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getSyncingResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getValidatorSetByHeightRequest.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/getValidatorSetByHeightResponse.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/header.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/module.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/partSetHeader.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/proofOp.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/proofOps.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/protocolVersion.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/validator.jsonis excluded by:!**/*.jsonsource/json_tables/chain/tendermint/versionInfo.jsonis excluded by:!**/*.json
Files selected for processing (8)
- source/includes/_account.md (28 hunks)
- source/includes/_binaryoptions.md (53 hunks)
- source/includes/_chainexchange.md (40 hunks)
- source/includes/_changelog.md (1 hunks)
- source/includes/_derivatives.md (97 hunks)
- source/includes/_spot.md (60 hunks)
- source/includes/_staking.md (42 hunks)
- source/index.html.md (1 hunks)
Files skipped from review due to trivial changes (3)
- source/includes/_account.md
- source/includes/_binaryoptions.md
- source/includes/_chainexchange.md
Additional comments: 31
source/index.html.md (1)
- 42-42: The addition of
tendermintto the list of topics is a valuable update, ensuring comprehensive coverage of the SDK's capabilities. This change aligns with the PR's objective to enhance documentation for thetendermintmodule queries.source/includes/_changelog.md (1)
- 3-6: The update to the changelog clearly documents the addition of support for all queries from the
tendermintmodule in the Python SDK v1.5.0. This is a significant enhancement, ensuring users are aware of the new capabilities available in the SDK.source/includes/_staking.md (6)
- 143-143: Please ensure that the line break added here is intentional and correctly placed for readability.
- 284-284: The line break added here improves the document's readability by separating sections.
- 433-433: Adding a line break here enhances the structure of the document, making it easier to navigate.
- 573-573: The insertion of a line break here is beneficial for document readability, ensuring a clear separation between sections.
- 597-597: This line break addition aids in maintaining a consistent and readable document structure.
- 606-606: The line break introduced here contributes to the document's readability by clearly delineating sections.
source/includes/_spot.md (10)
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-49]
The documentation and examples provided for retrieving a list of spot markets are comprehensive and well-structured. The inclusion of Python and Go code snippets, along with JSON-to-HTML table conversions, significantly enhances the readability and usability of the documentation. The request and response parameters are clearly outlined, making it easy for users to understand how to interact with the API.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [50-98]
The documentation for retrieving a specific spot market by ticker is detailed and informative. The examples provided in both Python and Go are practical and demonstrate the API's usage effectively. The JSON-to-HTML table conversion for the response parameters adds clarity to the documentation, allowing users to easily grasp the structure of the response.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [99-147]
The section on retrieving a list of spot markets with extra information is well-documented, with clear examples in Python and Go. The use of JSON-to-HTML table conversions for both request and response parameters enhances the documentation's clarity. This section effectively communicates how users can obtain more detailed information about spot markets.
- 149-155: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [148-196]
The documentation for retrieving a specific spot market with extra information is thorough and well-presented. The inclusion of code snippets in Python and Go, along with JSON-to-HTML table conversions, makes the documentation accessible and easy to follow. The detailed explanation of request and response parameters provides users with a clear understanding of how to use the API for this purpose.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [197-245]
The documentation for retrieving a spot market's order book is comprehensive and informative. The examples provided in both Python and Go languages demonstrate the API's functionality effectively. The JSON-to-HTML table conversion for the response parameters adds to the documentation's readability, allowing users to easily understand the structure of the order book data.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [246-294]
The section on retrieving a trader's spot orders is detailed and provides valuable information for users looking to query their own spot orders. The inclusion of code snippets in Python and Go, along with JSON-to-HTML table conversions, enhances the documentation's usability. The clear description of request and response parameters aids users in effectively interacting with the API.
- 320-326: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [295-343]
The documentation for retrieving all account address spot orders is well-structured and informative. The provided examples in Python and Go, along with JSON-to-HTML table conversions, make the documentation user-friendly and easy to understand. This section effectively guides users on how to retrieve spot orders for any account address.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [344-392]
The documentation for retrieving spot orders corresponding to specified order hashes is thorough and clearly explains the process. The inclusion of code snippets in Python and Go, along with JSON-to-HTML table conversions, significantly enhances the documentation's clarity. This section provides users with the necessary information to query spot orders based on their hashes.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [393-441]
The section on retrieving a trader's transient spot orders is detailed and provides a clear explanation of how users can query transient orders. The examples in Python and Go, along with JSON-to-HTML table conversions, contribute to the documentation's readability. This section effectively communicates the API's functionality for querying transient spot orders.
- 149-155: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [442-490]
The documentation for retrieving a spot market's mid-price is comprehensive and informative. The inclusion of code snippets in Python and Go, along with JSON-to-HTML table conversions, makes the documentation accessible and easy to follow. This section effectively guides users on how to obtain the mid-price for a specific spot market.
source/includes/_derivatives.md (13)
- 300-300: The addition of a line break before introducing the Level entity improves readability and structure. This formatting approach is consistent across all entities, which is good for maintaining a uniform documentation style.
- 459-459: The TrimmedDerivativeLimitOrder entity's documentation is introduced with a line break for better readability. This consistency in formatting is beneficial.
- 619-619: Noticed a repeated addition for TrimmedDerivativeLimitOrder. Ensure that the repetition is intentional and correctly placed within the documentation structure.
Verification successful
The repetition of TrimmedDerivativeLimitOrder sections in the documentation appears to be intentional, given the structured and contextual use observed in the provided snippets. Each instance of "TrimmedDerivativeLimitOrder" is followed by a JSON to HTML table conversion snippet, suggesting that the documentation aims to provide clear, context-specific information about "TrimmedDerivativeLimitOrder" in various scenarios. This pattern is common in technical documentation, especially when the same data structure is relevant to multiple sections or endpoints.
* 785-785: The repeated addition for **TrimmedDerivativeLimitOrder** appears again. It's crucial to verify the necessity of these repetitions to avoid potential confusion in the documentation.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify if the repeated sections for TrimmedDerivativeLimitOrder are intentional grep -C 3 "TrimmedDerivativeLimitOrder" source/includes/_derivatives.mdLength of output: 4206
Verification successful
The repeated mentions of TrimmedDerivativeLimitOrder in the documentation are intentional and serve to provide detailed information about its structure in various contexts. This approach ensures clarity and comprehensiveness in the documentation, especially when explaining crucial elements of the API's responses. Therefore, the repetitions are justified and necessary for the purpose of clarity.
* 948-948: Another instance of **TrimmedDerivativeLimitOrder**. As mentioned earlier, verifying the intention behind these repeated sections is important for clarity.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for multiple instances of TrimmedDerivativeLimitOrder to confirm if repetition is needed grep -C 3 "TrimmedDerivativeLimitOrder" source/includes/_derivatives.mdLength of output: 4206
Verification successful
The repetition of TrimmedDerivativeLimitOrder sections in the documentation appears to be intentional, serving to make each section self-contained. This approach ensures that readers who jump directly to a specific section have all the necessary information without needing to refer back to previous sections. The structure supports clarity and understanding for the reader by providing relevant details in each context where TrimmedDerivativeLimitOrder is mentioned.
* 1133-1133: Introduction of **FullDerivativeMarket** with a preceding line break is consistent with the documentation style. This helps in maintaining a clean and readable format. * 1144-1144: The **DerivativeMarket** entity is well introduced, following the established documentation formatting guidelines. * 1167-1167: The addition of **OracleType** documentation is consistent with the overall formatting and structure of the document. Good attention to detail in maintaining uniformity. * 1186-1186: **MarketStatus** documentation follows the established pattern of introducing entities, which aids in readability and navigability of the document. * 1198-1198: The **PerpetualMarketState** entity's documentation is introduced consistently with the rest of the document. This uniformity is beneficial for the reader. * 1207-1207: **PerpetualMarketInfo** is added following the consistent documentation style, which is good for maintaining readability. * 1219-1219: The addition of **PerpetualMarketFunding** documentation is in line with the document's formatting standards. This consistency is appreciated. * 1229-1229: **ExpiryFuturesMarketInfo** is introduced with the same attention to formatting as other entities, which is good for document consistency.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Further investigation into the repeated TrimmedDerivativeLimitOrder sections grep -C 3 "TrimmedDerivativeLimitOrder" source/includes/_derivatives.mdLength of output: 4206
tendermintmodule queriesNOTE: Do not merge this PR until Python SDK v1.6.0 is released in master
Summary by CodeRabbit
tendermintin the list of topics, expanding the scope of covered modules.tendermintmodule in the Python SDK v1.5.0, enriching the development toolkit.