chore: improve interface explanation #10
Merged
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
| // An exception is thrown if the contract name exists in multiple files. An optional filename (with .sol extension) can be provided to avoid ambiguity. | ||
| // By default, view and pure functions are excluded. An optional boolean flag can be set to include view and pure functions. | ||
| function createCalldata(string memory contractOrInterfaceName) external pure returns (bytes memory data); | ||
| function createCalldata(string memory contractOrInterfaceName, bool includeViewAndPureFunctions) external pure returns (bytes memory data); |
There was a problem hiding this comment.
adding a suggestion for my preference, but not a blocker:
Suggested change
| function createCalldata(string memory contractOrInterfaceName, bool includeViewAndPureFunctions) external pure returns (bytes memory data); | |
| function createCalldata(string memory contractOrInterfaceName, bool includeReadOnlyFunctions) external pure returns (bytes memory data); |
There was a problem hiding this comment.
i considered "ReadOnly" vs "ViewAndPure", but i feel the latter is less ambiguous. this is because, technically, there are read-only functions that are not marked view or pure, which will still be included even if this flag is set to false.
karmacoma-eth
approved these changes
Sep 24, 2024
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.
this improves the explanation of createCalldata interface