docs: Fix Typos in docs #7963
docs: Fix Typos in docs #7963
Conversation
|
|
@joeybright53 is attempting to deploy a commit to the thirdweb Team on Vercel. A member of the Team first needs to authorize it. |
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
WalkthroughDocumentation typo and capitalization corrections in three MDX pages within the portal’s TypeScript v5 docs. No code, logic, or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
the
Portal
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| ### Example: `transfer()` extension for ERC20 tokens | ||
|
|
||
| This extension conveniently handles unit conversion when transfering ERC20 tokens. You can pass the amount in tokens, the extension will convert it to the right unit before calling the contract. | ||
| This extension conveniently handles unit conversion when Transferring ERC20 tokens. You can pass the amount in tokens, the extension will convert it to the right unit before calling the contract. |
There was a problem hiding this comment.
The word "Transferring" should be lowercase in this context since it appears mid-sentence. The correct form would be "when transferring ERC20 tokens" rather than "when Transferring ERC20 tokens" to maintain proper sentence capitalization rules.
| This extension conveniently handles unit conversion when Transferring ERC20 tokens. You can pass the amount in tokens, the extension will convert it to the right unit before calling the contract. | |
| This extension conveniently handles unit conversion when transferring ERC20 tokens. You can pass the amount in tokens, the extension will convert it to the right unit before calling the contract. |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
apps/portal/src/app/typescript/v5/migrate/page.mdx (3)
51-56: Fix function name mismatch in example.Imported
getOwnedNFTsbut calledgetOwned. This will confuse readers.-import { getOwnedNFTs } from "thirdweb/extensions/erc721"; +import { getOwnedNFTs } from "thirdweb/extensions/erc721"; ... -const { data } = useReadContract(getOwned, { contract, owner }); +const { data } = useReadContract(getOwnedNFTs, { contract, owner });
125-133: Fix import typos and mismatched closing tag in React snippet.Stray brace, missing semicolons, and closing with
</V4TWProvider>instead of</ThirdwebProvider>.-import { ThirdwebProvider} from "@thirdweb-dev/react" } -import { ThirdwebProvider as ThirdwebProviderV5 } from "thirdweb/react" +import { ThirdwebProvider } from "@thirdweb-dev/react"; +import { ThirdwebProvider as ThirdwebProviderV5 } from "thirdweb/react"; ... -</V4TWProvider> +</ThirdwebProvider>
174-175: Fix import string in cheatsheet.Missing quotes around module name.
-| Provider | `import { ThirdwebProvider} from @thirdweb-dev/react` | [`import { ThirdwebProvider } from "thirdweb/react"`](/react/v5/ThirdwebProvider) | +| Provider | `import { ThirdwebProvider } from "@thirdweb-dev/react"` | [`import { ThirdwebProvider } from "thirdweb/react"`](/react/v5/ThirdwebProvider) |
🧹 Nitpick comments (7)
apps/portal/src/app/typescript/v5/migrate/page.mdx (5)
11-13: Update deprecation wording (past tense).June 23, 2025 has passed; reflect that v4 is already deprecated.
- The TypeScript SDK v4 will be deprecated on June 23, 2025. We highly recommend you to migrate to the latest version of the SDK v5 as soon as possible. + The TypeScript SDK v4 was deprecated on June 23, 2025. We highly recommend migrating to the latest version of the SDK v5 as soon as possible.
27-28: Grammar: “in terms of”.-Below is the comparison of 2 similar applications, using `ConnectWallet` (v4) & `ConnectButton` (v5), which are identical in term of functionality. +Below is the comparison of 2 similar applications, using `ConnectWallet` (v4) & `ConnectButton` (v5), which are identical in terms of functionality.
75-75: Grammar: “hundreds of”.-to building contract extensions. The SDK v5 currently supports over hundreds of extensions, with some popular protocols like Uniswap, Farcaster, Lens & more to come. +to building contract extensions. The SDK v5 currently supports hundreds of extensions, with popular protocols like Uniswap, Farcaster, Lens & more to come.
102-103: Consistent casing for utility name.-You can easily share the same wallet between the two SDKs by using the `ethers5adapter` utility, allowing you to progressively replace calls one by one. +You can easily share the same wallet between the two SDKs by using the `ethers5Adapter` utility, allowing you to progressively replace calls one by one.
138-153: Add missing imports and minor grammar fix in snippet.-import { useSigner } from "@thirdweb-dev/react"; -import { ethers5Adapter } from "thirdweb/adapters/ethers5"; +import { useSigner } from "@thirdweb-dev/react"; +import { prepareContractCall, sendTransaction } from "thirdweb"; +import { ethers5Adapter } from "thirdweb/adapters/ethers5"; ... - // convert the signer to used with the new SDK + // convert the signer to be used with the new SDKapps/portal/src/app/typescript/v5/extensions/examples/transfering-tokens/page.mdx (2)
22-23: Comma after introductory clause.-ERC1155 works in a similar way. However you must specify the quantity that you want to transfer, and an optional data parameter. +ERC1155 works in a similar way. However, you must specify the quantity that you want to transfer, and an optional data parameter.
55-58: Changeamount: 10nto a human‐readable type
TransferFromParamsdefinesamountasnumber|string(auto‐converted to wei); useamountWei(bigint) for raw units.- amount: 10n, // sending 10 tokens + amount: "10", // sending 10 tokens (human-readable; converted internally)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
apps/portal/src/app/typescript/v5/extensions/examples/transfering-tokens/page.mdx(1 hunks)apps/portal/src/app/typescript/v5/extensions/use/page.mdx(1 hunks)apps/portal/src/app/typescript/v5/migrate/page.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-06-06T23:47:55.122Z
Learnt from: MananTank
PR: thirdweb-dev/js#7298
File: apps/dashboard/src/app/nebula-app/move-funds/move-funds.tsx:255-277
Timestamp: 2025-06-06T23:47:55.122Z
Learning: The `transfer` function from `thirdweb/extensions/erc20` accepts human-readable amounts via the `amount` property and automatically handles conversion to base units (wei) by fetching the token decimals internally. Manual conversion using `toWei()` is not required when using the `amount` property.
Applied to files:
apps/portal/src/app/typescript/v5/extensions/examples/transfering-tokens/page.mdxapps/portal/src/app/typescript/v5/extensions/use/page.mdx
📚 Learning: 2025-05-20T18:54:15.781Z
Learnt from: MananTank
PR: thirdweb-dev/js#7081
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/assets/create/create-token-page-impl.tsx:110-118
Timestamp: 2025-05-20T18:54:15.781Z
Learning: In the thirdweb dashboard's token asset creation flow, the `transferBatch` function from `thirdweb/extensions/erc20` accepts the raw quantity values from the form without requiring explicit conversion to wei using `toUnits()`. The function appears to handle this conversion internally or is designed to work with the values in the format they're already provided.
Applied to files:
apps/portal/src/app/typescript/v5/extensions/examples/transfering-tokens/page.mdxapps/portal/src/app/typescript/v5/extensions/use/page.mdx
📚 Learning: 2025-05-20T19:03:35.954Z
Learnt from: MananTank
PR: thirdweb-dev/js#7081
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/assets/create/create-token-page-impl.tsx:160-165
Timestamp: 2025-05-20T19:03:35.954Z
Learning: The `claimTo` function in Thirdweb's ERC20 extension does not require converting the quantity to the smallest units (using toUnits) as it handles unit conversion internally or works with the units as provided.
Applied to files:
apps/portal/src/app/typescript/v5/extensions/use/page.mdx
🔇 Additional comments (2)
apps/portal/src/app/typescript/v5/extensions/examples/transfering-tokens/page.mdx (1)
1-1: LGTM — corrected heading spelling.apps/portal/src/app/typescript/v5/extensions/use/page.mdx (1)
61-62: LGTM — capitalization/spelling fix.
2 participants
Description
This PR corrects several minor typos in comments and documentation across the codebase. The changes are non-functional and purely textual to improve clarity and maintain a clean, professional codebase.
Details
Transfering→Transferringcurrenty→currentlyThese fixes help enhance readability and eliminate minor distractions during development and code reviews.
Additional Info
No logic or functionality has been modified. All changes are restricted to comments or non-executable doc annotations.
PR-Codex overview
This PR focuses on adding a new section about transferring tokens using thirdweb extensions and making minor text improvements for clarity in existing documentation.
Detailed summary
page.mdx.transfer()extension documentation for ERC20 tokens inpage.mdx.page.mdx.Summary by CodeRabbit