docs: instruct to not execute hooks with driver#508
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation for the solver driver was updated to clarify that pre- and post-hooks are managed automatically by the driver, and solver implementations should not invoke these hooks themselves. A minor formatting fix was also applied to remove an extra space in a sentence. 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: 0
🧹 Nitpick comments (2)
docs/cow-protocol/tutorials/arbitrate/solver/driver.md (2)
73-78: Fix comma splice in the newly added note.
The sentence“The driver runs pre- and post-hooks for the solver, don't execute these yourself in your solver code.”
is a comma splice—consider splitting it into two sentences or using a semicolon for clearer punctuation.
173-173: Add a comma before ‘but’ for readability.
In the sentence“…beyond the scope of this documentation but it's worth mentioning one guiding principle…”
insert a comma before “but” to separate the independent clauses.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/arbitrate/solver/driver.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/tutorials/arbitrate/solver/driver.md
[typographical] ~173-~173: Consider adding a comma here.
Context: ...from it. ## Considerations As you can see the driver has many responsibilities an...
(AS_YOU_CAN_SEE_COMMA)
[uncategorized] ~173-~173: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e beyond the scope of this documentation but it's worth mentioning one guiding princ...
(COMMA_COMPOUND_SENTENCE)
|
I have read the CLA Document and I hereby sign the CLA |
MartinquaXD
left a comment
MartinquaXD
left a comment
There was a problem hiding this comment.
Wording needs to changed slightly and some more context would be helpful.
Co-authored-by: Martin Magnus <martin.beckmann@protonmail.com>
Co-authored-by: Miguel Naveira <47919901+mrnaveira@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/cow-protocol/tutorials/arbitrate/solver/driver.md (1)
173-173: Improve sentence clarity with comma
Consider adding a comma before “but” to separate the independent clauses. For example:
…beyond the scope of this documentation, but it’s worth mentioning…
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/tutorials/arbitrate/solver/driver.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/tutorials/arbitrate/solver/driver.md
[typographical] ~173-~173: Consider adding a comma here.
Context: ...from it. ## Considerations As you can see the driver has many responsibilities an...
(AS_YOU_CAN_SEE_COMMA)
[uncategorized] ~173-~173: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e beyond the scope of this documentation but it's worth mentioning one guiding princ...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (1)
docs/cow-protocol/tutorials/arbitrate/solver/driver.md (1)
73-77: Clarify automatic hook handling in driver
The new note succinctly instructs solvers not to re-invoke pre- and post-hooks, since the driver already encodes them. This aligns with the PR objective to avoid double execution.
4 participants
Description
Changes
driverRelated Issues
We had a case where a solver executed pre and post hooks using the driver leading to these being mistakenly executed twice.
Summary by CodeRabbit