Skip to content

Commit 17d2404

Browse files
kilavvyzerosnacks
andauthored
fix minor documentation typos and grammar (#789)
- **StdCheats.sol**: Fix subject–verb agreement in comments describing Raw structs parsing from JSON. - **StdChains.sol**: Correct verb form in UX-related comment about `foundry.toml` alias. - **StdConfig.sol**: Fix wording of RPC endpoint caching comment for clarity. --------- Co-authored-by: zerosnacks <[email protected]>
1 parent 1a494e4 commit 17d2404

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

src/StdChains.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {VmSafe} from "./Vm.sol";
77
* StdChains provides information about EVM compatible chains that can be used in scripts/tests.
88
* For each chain, the chain's name, chain ID, and a default RPC URL are provided. Chains are
99
* identified by their alias, which is the same as the alias in the `[rpc_endpoints]` section of
10-
* the `foundry.toml` file. For best UX, ensure the alias in the `foundry.toml` file match the
10+
* the `foundry.toml` file. For best UX, ensure the alias in the `foundry.toml` file matches the
1111
* alias used in this contract, which can be found as the first argument to the
1212
* `setChainWithDefaultRpcUrl` call in the `initializeStdChains` function.
1313
*

src/StdCheats.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ abstract contract StdCheatsSafe {
1414
bool private gasMeteringOff;
1515

1616
// Data structures to parse Transaction objects from the broadcast artifact
17-
// that conform to EIP1559. The Raw structs is what is parsed from the JSON
17+
// that conform to EIP1559. The Raw structs are what are parsed from the JSON
1818
// and then converted to the one that is used by the user for better UX.
1919

2020
struct RawTx1559 {
@@ -63,7 +63,7 @@ abstract contract StdCheatsSafe {
6363
}
6464

6565
// Data structures to parse Transaction objects from the broadcast artifact
66-
// that DO NOT conform to EIP1559. The Raw structs is what is parsed from the JSON
66+
// that DO NOT conform to EIP1559. The Raw structs are what are parsed from the JSON
6767
// and then converted to the one that is used by the user for better UX.
6868

6969
struct TxLegacy {

src/StdConfig.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ contract StdConfig {
103103
uint256 chainId = resolveChainId(chain_key);
104104
_chainKeys.push(chain_key);
105105

106-
// Cache the configure rpc endpoint for that chain.
106+
// Cache the configured RPC endpoint for that chain.
107107
// Falls back to `[rpc_endpoints]`. Panics if no rpc endpoint is configured.
108108
try vm.parseTomlString(content, string.concat("$.", chain_key, ".endpoint_url")) returns (
109109
string memory url

0 commit comments

Comments
 (0)