-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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: docs #951
fix: docs #951
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
❌ Changes requested. Reviewed everything up to a087b93 in 29 seconds
More details
- Looked at
14
lines of code in1
files - Skipped
0
files when reviewing. - Skipped posting
0
drafted comments based on config settings.
Workflow ID: wflow_TocBY9w2J7kNQZ3S
Want Ellipsis to fix these issues? Tag @ellipsis-dev
in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet
mode, and more.
@@ -143,6 +143,9 @@ listener.wait_forever() | |||
</Tab> | |||
<Tab title="Javascript"> | |||
```javascript | |||
import { Composio } from "composio-core"; |
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.
The import statement should match the toolset used in the rest of the code. Consider using OpenAIToolSet
instead of Composio
to maintain consistency with the rest of the JavaScript examples.
Code Review SummaryThe changes in this PR improve the JavaScript documentation example by adding necessary setup code that was previously missing. The changes are accurate and align well with the actual implementation in the codebase. Positive Aspects:
Minor Suggestions:Consider adding a brief comment above the code example to explain what the code demonstrates, similar to other documentation patterns in the codebase. Overall, this is a good documentation fix that improves the developer experience by providing complete, working code examples. 👍 Rating: 8/10 - Good documentation improvement that fixes a critical missing setup code. |
@@ -143,6 +143,9 @@ listener.wait_forever() | |||
</Tab> | |||
<Tab title="Javascript"> | |||
```javascript |
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.
Consider adding a brief comment above this code block to explain what this example demonstrates, similar to other documentation patterns. For example:
// Example: Setting up a trigger listener to handle incoming events
This comment was generated by github-actions[bot]! JS SDK Coverage Report📊 Coverage report for JS SDK can be found at the following URL: 📁 Test report folder can be found at the following URL: |
Important
Add import and initialization for
Composio
in JavaScript example intriggers.mdx
.triggers.mdx
, added import statement forComposio
and initialization oftoolset
in the JavaScript example for listening to triggers.This description was created by for a087b93. It will automatically update as commits are pushed.