-
Notifications
You must be signed in to change notification settings - Fork 52
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.
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
fix: typos in documentation files #526
base: master
Are you sure you want to change the base?
Conversation
@leopardracer is attempting to deploy a commit to the distributed-crafts Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request updates a type name in the mempool module by renaming Changes
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
sdk/src/mempool.ts (1)
5-15
: Minor suggestion: Consider updating API naming in commentsThe comments refer to "Memopool API" but the constants are named "MEMPOOL_BASE_PATH". Consider updating the comments to consistently use "Mempool" instead of "Memopool" for better alignment with the code.
- * Base path for the mainnet Memopool API. + * Base path for the mainnet Mempool API. ... - * Base path for the testnet Memopool API. + * Base path for the testnet Mempool API. ... - * Base path for the regtest Memopool API. + * Base path for the regtest Mempool API.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
sdk/src/mempool.ts
(3 hunks)sdk/src/wallet/utxo.ts
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- sdk/src/wallet/utxo.ts
🔇 Additional comments (4)
sdk/src/mempool.ts (4)
20-20
: Excellent typographical correction!You've appropriately fixed the spelling error in the type name, changing
MempoolRecomendedFee
toMempoolRecommendedFee
. This kind of attention to detail improves code quality and readability.
79-79
: Good documentation update!You've correctly updated the JSDoc return type annotation to use the fixed type name. Maintaining consistency between code and documentation is important.
88-88
: Return type properly corrected!The method return type has been consistently updated to use the corrected type name.
89-89
: Type parameter correctly updated!You've systematically updated the generic type parameter in the method call to match the renamed type.
This pull request contains changes to improve clarity, correctness and structure.
Summary by CodeRabbit