Skip to content

docs: fix typos in README and CLAUDE.md #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos in README and CLAUDE.md #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ import {MyHelper} from './MyHelper.sol';

- **Test file names**: `ContractName.t.sol`
- **Test contract names**: `ContractNameTest` or `functionNameTest`
- **Test function names**: If the test contract is already named after the function, omit the funciton name from the test, such as : `test_outcome_optionalContext`, otherwise, if it's not already clear which function is being tested due to the name of the test contract, include the function name in the test name like `test_functionName_outcome_optionalContext`
- **Test function names**: If the test contract is already named after the function, omit the function name from the test, such as : `test_outcome_optionalContext`, otherwise, if it's not already clear which function is being tested due to the name of the test contract, include the function name in the test name like `test_functionName_outcome_optionalContext`

**Test Organization Principles:**

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ bytes memory hookData = abi.encode(

## Core Payout Operations

**Note that fee-on-transfer tokens and rebasing tokens may lead to unexpected behavior and are not recommneded for use in Flywheel.**
**Note that fee-on-transfer tokens and rebasing tokens may lead to unexpected behavior and are not recommended for use in Flywheel.**

Flywheel provides four fundamental payout operations that hooks can implement based on their requirements:

Expand Down