Merge pull request #33 from imclerran/update-docs

Clarify that Chat.initClient and Prompt.initClient are Client.inti
imclerran · Dec 28, 2024 · 4a72327 · 4a72327
2 parents b319473 + 772e299
commit 4a72327
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/package/Chat.roc b/package/Chat.roc
@@ -36,6 +36,7 @@ Client : Client.Client
 ## ```
 ## client = Chat.initClient { apiKey: "your_openrouter_api_key" }
 ## ```
+## Same as `Client.init`.
 initClient = Client.init
 
 ## The OpenAI ChatML standard message used to query the AI model.

diff --git a/package/Prompt.roc b/package/Prompt.roc
@@ -57,8 +57,11 @@ PromptResponseBody : {
     },
 }
 
-## Initialize the OpenRouter API client with the required API key.
-## Other parameters may optionally be set during initialization, or assigned later using the Client module setters.
+## Initialize the OpenRouter API client with the required API key. All parameters besides apiKey are completely optional, and may be set during initialization, assigned later, or left as their defaults.
+## ```
+## client = Chat.initClient { apiKey: "your_openrouter_api_key" }
+## ```
+## Same as `Client.init`.
 initClient = Client.init
 
 ## Create a request object to be sent with basic-cli's Http.send using a prompt string