Improved chatgpt.isIdle() description/example

KudoAI · Jun 23, 2024 · 37a6076 · 37a6076
1 parent 9138fd0
commit 37a6076
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
@@ -950,15 +950,14 @@ console.log(fifthResp); // Example output: 'Hello from ChatGPT!'
 
 ### isIdle `async`
 
-Returns a boolean value. `true` if ChatGPT has finished generating a response, `false` otherwise.
+Resolves a promise when ChatGPT has finished generating a response.
 
 Example code:
 
 ```js
 (async () => {
-    if (await chatgpt.isIdle()) {
-        // Do something
-    }
+    await chatgpt.code.isIdle();
+    console.log('ChatGPT is idle');
 })();
 ```