search

MacPaw / OpenAI

Swift community driven package for OpenAI public API
MIT License
2.11k stars 357 forks source link

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

Open monchewharry opened 1 month ago

monchewharry commented 1 month ago

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
sonarcloud[bot] commented 1 month ago

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