1
0
Fork 0

Add some docstrings

This commit is contained in:
Bram Schoenmakers 2023-12-25 13:06:56 +01:00
parent 50939d0f9d
commit 3851a2ff4a
Signed by: bram
GPG key ID: 0CCD19DFDC63258F

View file

@ -235,6 +235,9 @@ list of conses."
(kagi--call-summarizer request-obj))) (kagi--call-summarizer request-obj)))
(defun kagi--get-summary (f) (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)) (let* ((response (funcall f))
(parsed-response (json-parse-string response)) (parsed-response (json-parse-string response))
(data (gethash "data" parsed-response)) (data (gethash "data" parsed-response))
@ -242,6 +245,9 @@ list of conses."
(kagi--format-output output))) (kagi--format-output output)))
(defun kagi--display-summary (f buffer-name) (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))) (let ((summary (kagi--get-summary f)))
(with-current-buffer (get-buffer-create buffer-name) (with-current-buffer (get-buffer-create buffer-name)
(insert summary) (insert summary)