Fix doc-comment in RpcTester::fetch_block to reference rpc2 instead of nonexistent truth#27
Open
autumncrypto wants to merge 1 commit intotempoxyz:mainfrom
Open
Fix doc-comment in RpcTester::fetch_block to reference rpc2 instead of nonexistent truth#27autumncrypto wants to merge 1 commit intotempoxyz:mainfrom
RpcTester::fetch_block to reference rpc2 instead of nonexistent truth#27autumncrypto wants to merge 1 commit intotempoxyz:mainfrom
Conversation
…ad of nonexistent `truth` PR Description (English) Problem: In the RpcTester::fetch_block method, the doc-comment states that blocks are fetched from self.truth. However, the truth field does not exist — blocks are actually fetched from self.rpc2. This discrepancy can mislead readers or developers relying on the documentation. Solution: Updated the doc-comment to accurately reflect the implementation: ```rust /// Fetches block and block identifiers from `self.rpc2`. ``` Changes: Only the comment is modified; the function’s logic remains unchanged. Improves readability and correctness of the documentation. Additional Notes: The comment now explicitly mentions the “reference RPC,” making it clearer for new developers. No other code dependencies on truth exist; no side effects.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Description (English)
Problem:
In the RpcTester::fetch_block method, the documentation comment states that blocks are retrieved from self.truth. However, self.rpc2 is actually used. This appears to serve as the reference RPC node for block data, although it’s not formally documented everywhere. This discrepancy may be misleading.
Solution:
Updated the doc-comment to accurately reflect the implementation:
/// Fetches block and block identifiers from `self.rpc2`.Changes: