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

Remove openaischema from index.md #129

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Remove openaischema from index.md #129

merged 1 commit into from
Oct 30, 2023

Conversation

jxnl
Copy link
Collaborator

@jxnl jxnl commented Oct 30, 2023

addresses #127

Summary by CodeRabbit

Documentation:

  • Removed the "Introduction to OpenAISchema" section from the index page. This section previously provided a quick start guide for using OpenAI Function Call, including topics such as defining a schema, adding additional prompting, calling the ChatCompletion API, and deserializing the response.
  • Removed mention of IDE support from the documentation.

Please note that these changes may affect your initial understanding and usage of OpenAI Function Call. We recommend referring to other sections of the documentation for guidance.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2023

Walkthrough

The primary change involves the removal of the "Introduction to OpenAISchema" section from the docs/index.md file. This section provided a quick start guide for using OpenAI Function Call, including defining a schema, adding additional prompting, calling the ChatCompletion API, and deserializing the response. Additionally, a reference to IDE support was also removed.

Changes

File Summary
docs/.../index.md Removed the "Introduction to OpenAISchema" section which provided a quick start guide for using OpenAI Function Call. Also, a mention of IDE support was removed.

Poem

🍂 As the leaves fall, so do old ways, 🍁
In the spirit of Halloween, we've carved away. 🎃
No more OpenAISchema, no more IDE play,
Like a rabbit in autumn, we hop to a new day. 🐇
So here's to the changes, may they lead us astray,
To unexplored paths, in the AI array. 🌌
And as the moon rises, we rabbits say,
"Happy coding to all, and to all a good day!" 🌕


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.json

@jxnl jxnl merged commit 0142aee into main Oct 30, 2023
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0d5eca5 and 52d5b79.
Files selected for processing (1)
  • docs/index.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/index.md

@jxnl jxnl deleted the clean-up-index branch November 7, 2023 04:08
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.

1 participant