Working on docs on positions and adapters #194
Conversation
|
Warning Rate limit exceeded@zmanian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 48 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis update introduces new documentation for managing positions and adapters within the Sommelier Network Cellar contracts. Specifically, it includes the creation of Changes
Poem
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/adapters.md (1 hunks)
- docs/positions.md (1 hunks)
Additional context used
LanguageTool
docs/positions.md
[uncategorized] ~3-~3: The preposition ‘of’ seems more likely in this position.
Context: ...sitions A Position is an instantiation for an adapter for a specific asset. A cell...(AI_HYDRA_LEO_REPLACE_FOR_OF)
[grammar] ~7-~7: There seems to be a noun/verb agreement error. Did you mean “adds” or “added”?
Context: ... a position is as follows: 1. A cellar add an adapter that has been trusted by Reg...(SINGULAR_NOUN_VERB_AGREEMENT)
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...apter that has been trusted by Registry withAddAdapterToCatalogue2. A cellar add...(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~9-~9: Possible typo: you repeated a word
Context: ...terToCatalogue3.AddPosition` places the the position in the internal index and pass...(ENGLISH_WORD_REPEAT_RULE)
docs/adapters.md
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...ers integrate Cellars with extenal Defi protocols enabling them to use the assets in the ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~5-~5: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...the assets in the protocol. We have an establish catalogue of adapters that can be used ...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~9-~9: Did you mean “is” or “was”, “were”?
Context: ...he following protocols: ## Aave Thare are adapters for both Aave V2 and V3. The ...(NNP_VBP_TO_VBZ)
Markdownlint
docs/adapters.md
14-14: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
49-49: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
54-54: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
69-69: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
14-14: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
|
|
||
| The adapter supports swaps against both Uniswap V2 and V3. It supports holding multiple NFT LP positions in Uniswap V3. | ||
|
|
||
|
|
There was a problem hiding this comment.
Fix markdown linting issues.
There are multiple consecutive blank lines.
-
+ Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
69-69: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit
adapters.md, detailing integration with various DeFi protocols.positions.md, explaining the setup and management of positions in Cellars.README.mdwith information on managing positions and adapters in Sommelier Network Cellar contracts.