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

[docs] index watsonx example #642

Merged
merged 2 commits into from
May 4, 2024
Merged

[docs] index watsonx example #642

merged 2 commits into from
May 4, 2024

Conversation

h0rv
Copy link
Contributor

@h0rv h0rv commented May 1, 2024

  • update mkdocs
  • fix typo

Please use conventional commits to describe your changes. For example, feat: add new feature or fix: fix a bug. If you are unsure, leave the title as ... and AI will handle it.

Describe your changes

...

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • If it is a core feature, I have added thorough tests.
  • If it is a core feature, I have added documentation.

🚀 This description was created by Ellipsis for commit 978c08f

Summary:

This PR corrects a typo in the watsonx.md documentation and updates the navigation in mkdocs.yml to include this document.

Key points:

  • Fixed typo in docs/examples/watsonx.md.
  • Updated mkdocs.yml to include watsonx.md in the navigation under 'Cookbook'.

Generated with ❤️ by ellipsis.dev

@h0rv h0rv changed the title index watsonx example [docs] index watsonx example May 1, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me!

  • Reviewed the entire pull request up to 978c08f
  • Looked at 34 lines of code in 2 files
  • Took 41 seconds to review
More info
  • Skipped 0 files when reviewing.
  • Skipped posting 2 additional comments because they didn't meet confidence threshold of 85%.
1. docs/examples/watsonx.md:9:
  • Assessed confidence : 0%
  • Comment:
    The typo fix from 'xatsonx' to 'watsonx' is correctly implemented.
  • Reasoning:
    The PR description mentions updating mkdocs and fixing a typo. The typo fix in the watsonx.md file is correct, changing 'xatsonx' to 'watsonx'. The mkdocs.yml file has been updated to include the new watsonx.md in the navigation under the 'Cookbook' section. This aligns with the PR description and seems correctly implemented.
2. mkdocs.yml:147:
  • Assessed confidence : 0%
  • Comment:
    The addition of the 'IBM watsonx.ai' entry in the mkdocs.yml file is correctly placed under the 'Cookbook' section.
  • Reasoning:
    The PR description mentions updating mkdocs and fixing a typo. The typo fix in the watsonx.md file is correct, changing 'xatsonx' to 'watsonx'. The mkdocs.yml file has been updated to include the new watsonx.md in the navigation under the 'Cookbook' section. This aligns with the PR description and seems correctly implemented.

Workflow ID: wflow_NtNFFUtzrMIqjPOd


You can customize Ellipsis with review rules, user-specific overrides, quiet mode, and more. See docs.

@jxnl jxnl merged commit ef0d0b0 into instructor-ai:main May 4, 2024
2 of 12 checks passed
@h0rv h0rv deleted the fix-watsonx branch May 4, 2024 15:52
boydgreenfield pushed a commit to boydgreenfield/instructor that referenced this pull request May 17, 2024
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.

2 participants