Docs: Fixed the Cheatcodes Error In Docs #3133
Open
+123
−119
Conversation
This file contains 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
kkawula
reviewed
Mar 24, 2025
| @@ -3,7 +3,7 @@ | |||
| Cheatcodes modifying `block_number`: | |||
|
|
|||
| ## `cheat_block_number` | |||
| > `fn cheat_block_number(target: ContractAddress, block_number: u64, span: CheatSpan)` | |||
| > `fn cheat_block_number(contract_address: ContractAddress, block_number: u64, span: CheatSpan)` | |||
|
|
|||
| Changes the block number for the given target and span. | |||
There was a problem hiding this comment.
Suggested change
| Changes the block number for the given target and span. | |
| Changes the block number for the given contract address and span. |
| @@ -13,12 +13,12 @@ Changes the block number for the given target and span. | |||
| Changes the block number for all targets. | |||
There was a problem hiding this comment.
Suggested change
| Changes the block number for all targets. | |
| Changes the block number for all contracts. |
| @@ -13,12 +13,12 @@ Changes the block number for the given target and span. | |||
| Changes the block number for all targets. | |||
|
|
|||
| ## `start_cheat_block_number` | |||
| > `fn start_cheat_block_number(target: ContractAddress, block_number: u64)` | |||
| > `fn start_cheat_block_number(contract_address: ContractAddress, block_number: u64)` | |||
|
|
|||
| Changes the block number for the given target. | |||
There was a problem hiding this comment.
Suggested change
| Changes the block number for the given target. | |
| Changes the block number for the given contract address. |
|
|
||
| Changes the block number for the given target. | ||
|
|
||
| ## `stop_cheat_block_number` | ||
| > `fn stop_cheat_block_number(target: ContractAddress)` | ||
| > `fn stop_cheat_block_number(contract_address: ContractAddress)` | ||
|
|
||
| Cancels the `cheat_block_number` / `start_cheat_block_number` for the given target. |
There was a problem hiding this comment.
Suggested change
| Cancels the `cheat_block_number` / `start_cheat_block_number` for the given target. | |
| Cancels the `cheat_block_number` / `start_cheat_block_number` for the given contract address. |
added 2 commits
March 26, 2025 04:49
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #3106
Introduced changes
Updated
target: ContractAddressin cheatcodes section of docs tocontract_address: ContractAddress, making sure to do this where it was appropriate by looking into the snforge_stdChecklist
CHANGELOG.md