feat(widget): add description for slippage config - #516
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA new "Slippage configuration" section was added to the widget tutorial documentation. It describes how to declaratively set global or per-network slippage limits for the CoW Swap widget, introduces the Changes
Poem
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. 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 (
|
|
All contributors have signed the CLA ✍️ ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/cow-protocol/tutorials/widget/widget.md (2)
256-257: Duplicate horizontal rule — keep only one---Two consecutive
---lines render as two horizontal rules. One is sufficient and avoids visual noise.---- ---- +---
421-421: Grammar tweakRemove the article before the plural noun.
-| You can set up a slippage settings for all networks in the widget. +| You can configure slippage settings for all networks in the widget.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/widget/widget.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/tutorials/widget/widget.md
[grammar] ~421-~421: The plural noun “settings” cannot be used with the article “a”.
Context: ...--- | You can set up a slippage settings for all networks in the widget. See [Sl...
(A_NNS)
|
I have read the CLA Document and I hereby sign the CLA |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/cow-protocol/tutorials/widget/widget.md (2)
321-327: Tighten wording around auto-slippage behaviourIn the “Auto slippage” rule it isn’t fully clear what happens when
defaultValueis undefined or when auto-slippage exceedsdefaultValuebut is still within[min,max]. Consider adding one extra sentence to cover those edge cases to remove any ambiguity for integrators.
Example:If
defaultValueis undefined the widget falls back to X bps (internal default). If auto-slippage is higher thandefaultValuebut still inside the allowed range, the detected auto-slippage is used unchanged.
421-421: Fix minor grammar glitch in parameter description“A slippage settings” → “slippage settings”.
-| You can set up a slippage settings for all networks in the widget. +| You can set up slippage settings for all networks in the widget.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/widget/widget.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/tutorials/widget/widget.md
[grammar] ~421-~421: The plural noun “settings” cannot be used with the article “a”.
Context: ...--- | You can set up a slippage settings for all networks in the widget. See [Sl...
(A_NNS)
🔇 Additional comments (1)
docs/cow-protocol/tutorials/widget/widget.md (1)
260-276: 👍 Interface definition looks solidThe
SlippageConfiginterface is self-explanatory and the comments clearly convey intent. Optional fields make sense given the clamping rules below. Nothing to flag here.
3 participants
Description
Adds full documentation for the new slippage configuration feature
Changes
Summary by CodeRabbit