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

do you consider building a doc for this SDK? #235

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

monchewharry
Copy link

What

I run jazzy to create a docs folder mimicking the apple style documentation for your work.

Why

sometimes option click is not enough for someone like me to learn your work from a structured view.

Affected Areas

  1. new folder docs is generated by the tool jazzy
  2. copied example print of chat completion object from OpenAI's API reference at https://platform.openai.com/docs/api-reference/chat/object, placed at Sources/OpenAI/Public/Models/ChatResult.swift line 9
image

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
56.8% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

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