Fix/documentation typos #243
Merged
Conversation
This file contains hidden or 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
Fix style guide violation by adding braces around one-line if statements that call revert. This ensures compliance with Compose's coding standards which require all if statements to use braces. Fixes two instances in safeTransferFrom functions (lines 331 and 354).
- Fix 'Descrition' -> 'Description' in solidity-modules.mdx - Fix 'facet modules' -> 'facet module' (singular) in design-for-composition.mdx - Fix 'ERC20BridgableFacet' -> 'ERC20BridgeableFacet' in reusable-facet-logic.mdx - Fix numbering in composable-facets.mdx (1, 3, 4 -> 1, 2, 3) - Fix 'It's own' -> 'Its own' in diamond-contracts.mdx
👷 Deploy request for compose-diamonds pending review.Visit the deploys page to approve it
|
Coverage Report
Last updated: Fri, 05 Dec 2025 11:03:58 GMT for commit |
Gas ReportNo gas usage changes detected between All functions maintain the same gas costs. ✅ Last updated: Fri, 05 Dec 2025 11:04:42 GMT for commit |
Contributor
|
@panditdhamdhere Thanks for these fixes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR fixes 5 typos and errors found in the documentation files across the website/docs directory. These are minor corrections that improve the accuracy and professionalism of the documentation.
Changes Made
website/docs/foundations/solidity-modules.mdx(Line 4)website/docs/design/design-for-composition.mdx(Line 26)website/docs/foundations/reusable-facet-logic.mdx(Line 43)website/docs/foundations/composable-facets.mdx(Lines 80-82)website/docs/foundations/diamond-contracts.mdx(Line 21)Checklist
Code follows the Solidity feature ban - N/A - Documentation changes only
Code follows Design Principles - N/A - Documentation changes only
Code matches the codebase style - N/A - Documentation changes only
Code is formatted with
forge fmt- N/A - Documentation changes onlyExisting tests pass - N/A - Documentation changes only, no code changes
New tests are optional - N/A - No new functionality added
All tests pass - N/A - Documentation changes only
Documentation updated - ✅ Fixed typos and errors in existing documentation
Additional Notes