update doc

jupyterlab · Sep 6, 2024 · cdf864b · cdf864b
1 parent 7b185a1
commit cdf864b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/jupyter-ai/jupyter_ai/history.py b/packages/jupyter-ai/jupyter_ai/history.py
@@ -46,7 +46,9 @@ async def aadd_messages(self, messages: Sequence[BaseMessage]) -> None:
         self.add_messages(messages)
 
     def clear(self, human_msg_id: Optional[str] = None) -> None:
-        """Clear all messages after the given time"""
+        """Clears conversation exchanges. If `human_msg_id` is provided, only
+        clears the respective human message and its reply. Otherwise, clears
+        all messages."""
         if human_msg_id:
             self._all_messages = [
                 m