Skip to content

Commit 2f05b30

Browse files
authored
docs: polish wording and fix minor grammar (#785)
1 parent 480d876 commit 2f05b30

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ contract TestContract is Test {
9191
assertEq(test.exists(), 100);
9292
}
9393
94-
// It supports arbitrary storage layouts, like assembly based storage locations
94+
// It supports arbitrary storage layouts, like assembly-based storage locations
9595
function testFindHidden() public {
96-
// `hidden` is a random hash of a bytes, iteration through slots would
96+
// `hidden` is a random hash of bytes; iterating through slots would
9797
// not find it. Our mechanism does
9898
// Also, you can use the selector instead of a string
9999
uint256 slot = stdstore.target(address(test)).sig(test.hidden.selector).find();
@@ -167,7 +167,7 @@ contract Storage {
167167

168168
### stdCheats
169169

170-
This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for addresses that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.
170+
This is a wrapper around miscellaneous cheatcodes that need wrappers to be more dev-friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly, this `hoax` function should only be used for addresses that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.
171171

172172
#### Example usage:
173173

RELEASE_CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ This checklist is meant to be used as a guide for the `forge-std` release proces
88
- [ ] Open and merge a PR with the version bump
99
- [ ] Tag the merged commit with the version number: `git tag v<X.Y.Z>`
1010
- [ ] Push the tag to the repository: `git push --tags`
11-
- [ ] Create a new GitHub release with the automatically generated changelog and with the name set to `v<X.Y.Z>`
11+
- [ ] Create a new GitHub release with the automatically generated changelog and the name set to `v<X.Y.Z>`
1212
- [ ] Add `## Featured Changes` section to the top of the release notes

0 commit comments

Comments
 (0)