contracts
contracts copied to clipboard
Improved docs
Motivation
(https://github.com/farcasterxyz/contracts/blob/main/src/IdGateway.sol) (https://github.com/farcasterxyz/contracts/blob/main/src/KeyGateway.sol) (https://github.com/farcasterxyz/contracts/blob/main/src/StorageRegistry.sol)
Change Summary
StorageRegistery -> StorageRegistry; inital owner -> initial owner; withan -> with an
Merge Checklist
Choose all relevant options below by adding an x now or at any time before submitting for review
- [x] The PR title adheres to the conventional commits standard
- [ ] The PR has been tagged with change type label(s) (i.e. documentation, feature, bugfix, or chore)
- [x] The PR's changes adhere to all the requirements in the contribution guidelines
- [x] All commits have been signed
Additional Context
fixes #434
PR-Codex overview
This PR focuses on correcting typos in the documentation comments across multiple Solidity files, ensuring clarity and accuracy in parameter descriptions.
Detailed summary
- In
src/IdGateway.sol, corrected "StorageRegistery" to "StorageRegistry". - In
src/KeyGateway.sol, corrected "inital" to "initial" in the parameter description. - In
src/StorageRegistry.sol, fixed "withan" to "with an" in the error comment.
✨ Ask PR-Codex anything about this PR by commenting with
/codex {your question}