From 3851a2ff4a05ee10d040d9bd4597cc75718e9b3f Mon Sep 17 00:00:00 2001 From: Bram Schoenmakers Date: Mon, 25 Dec 2023 13:06:56 +0100 Subject: [PATCH] Add some docstrings --- kagi.el | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/kagi.el b/kagi.el index a4e88d7..50470d2 100644 --- a/kagi.el +++ b/kagi.el @@ -235,6 +235,9 @@ list of conses." (kagi--call-summarizer request-obj))) (defun kagi--get-summary (f) + "Return a summary text. + + F is a function to call the summarizer API that returns a JSON response." (let* ((response (funcall f)) (parsed-response (json-parse-string response)) (data (gethash "data" parsed-response)) @@ -242,6 +245,9 @@ list of conses." (kagi--format-output output))) (defun kagi--display-summary (f buffer-name) + "Display the summary in a buffer called BUFFER-NAME. + +F is a function to call the summarizer API that returns a JSON response." (let ((summary (kagi--get-summary f))) (with-current-buffer (get-buffer-create buffer-name) (insert summary)