Skip to content
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 minor typo (extra paren in code snippet) on OpenAi docs page #588

Merged

Conversation

thaddavis
Copy link
Contributor

@thaddavis thaddavis commented Dec 16, 2024

🔍 Review Summary

Purpose

  • Enhance clarity and usability for developers integrating with OpenAI by correcting a typographical error in the documentation.

Changes

  • Documentation Update:
    • Corrected a typographical error by removing unnecessary parentheses in the code snippet for creating chat completions with the OpenAI client.

Impact

  • Improves the clarity and correctness of the code snippet, facilitating easier integration for developers working with OpenAI.
Original Description

No existing description found

Copy link

Walkthrough

This update resolves a minor typographical error in the OpenAI documentation by removing an unnecessary parenthesis in a code snippet. This correction ensures the example code is syntactically correct, enhancing clarity and usability for developers integrating with OpenAI.

Changes

File(s) Summary
docs/v1/integrations/openai.mdx Corrected a typographical error by removing an extra parenthesis in the code snippet for creating chat completions with the OpenAI client.

🔗 Related PRs

Instructions

Emoji Descriptions:

  • ⚠️ Potential Issue - May require further investigation.
  • 🔒 Security Vulnerability - Fix to ensure system safety.
  • 💻 Code Improvement - Suggestions to enhance code quality.
  • 🔨 Refactor Suggestion - Recommendations for restructuring code.
  • ℹ️ Others - General comments and information.

Interact with the Bot:

  • Send a message or request using the format:
    @bot + *your message*
Example: @bot Can you suggest improvements for this code?
  • Help the Bot learn by providing feedback on its responses.
    @bot + *feedback*
Example: @bot Do not comment on `save_auth` function !

Execute a command using the format:

@bot + */command*

Example: @bot /updateCommit

Available Commands:

  • /updateCommit ✨: Apply the suggested changes and commit them (or Click on the Github Action button to apply the changes !)
  • /updateGuideline 🛠️: Modify an existing guideline.
  • /addGuideline ➕: Introduce a new guideline.

Tips for Using @bot Effectively:

  • Specific Queries: For the best results, be specific with your requests.
    🔍 Example: @bot summarize the changes in this PR.
  • Focused Discussions: Tag @bot directly on specific code lines or files for detailed feedback.
    📑 Example: @bot review this line of code.
  • Managing Reviews: Use review comments for targeted discussions on code snippets, and PR comments for broader queries about the entire PR.
    💬 Example: @bot comment on the entire PR.

Need More Help?

📚 Visit our documentation for detailed guides on using Entelligence.AI.
🌐 Join our community to connect with others, request features, and share feedback.
🔔 Follow us for updates on new features and improvements.

@the-praxs the-praxs self-requested a review December 16, 2024 23:25
@the-praxs the-praxs enabled auto-merge (squash) December 16, 2024 23:25
Copy link
Member

@the-praxs the-praxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@the-praxs the-praxs merged commit 2a48bd6 into AgentOps-AI:main Dec 16, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants