From: Eshel Yaron <me@eshelyaron.com>
Date: Sun, 17 Sep 2023 06:44:56 +0000 (+0200)
Subject: ; * sweeprolog.el: Add docstrings for recently added functions
X-Git-Tag: V9.1.15-sweep-0.25.0~1
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4ad04a8351d5e8b0426d73f4284222113b3f28aa;p=sweep.git

; * sweeprolog.el: Add docstrings for recently added functions
---

diff --git a/sweeprolog.el b/sweeprolog.el
index a507d67..6a6c0fb 100644
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -662,6 +662,7 @@ pack completion candidates."
 ;;;; Initialization
 
 (defun sweeprolog--load-module (line)
+  "Load the dynamic module that LINE describes."
   (save-match-data
     (when (string-match (rx bos
                             (or "L" "M")
@@ -694,6 +695,7 @@ pack completion candidates."
                          "and up to date")))))))
 
 (defun sweeprolog-ensure-initialized ()
+  "Initilize Prolog, unless already initilized."
   (sweeprolog--ensure-module)
   (sweeprolog-init))
 
@@ -715,6 +717,7 @@ extra initialization arguments."
     (sweeprolog-setup-message-hook)))
 
 (defun sweeprolog-maybe-kill-top-levels ()
+  "Ask before killing running Prolog top-levels."
   (let ((top-levels (seq-filter (lambda (buffer)
                                   (with-current-buffer buffer
                                     (and (derived-mode-p 'sweeprolog-top-level-mode)
@@ -730,6 +733,7 @@ extra initialization arguments."
                  (sweeprolog-top-level-delete-process buffer)))))))
 
 (defun sweeprolog-shutdown ()
+  "Shutdown Prolog."
   (message "Stopping Sweep.")
   (sweeprolog--query-once "sweep" "sweep_cleanup_threads" nil)
   (sweeprolog-cleanup)
@@ -737,6 +741,7 @@ extra initialization arguments."
         sweeprolog-prolog-server-port nil))
 
 (defun sweeprolog-maybe-shutdown ()
+  "Ask before killing running top-levels and shutdown Prolog."
   (when (sweeprolog-maybe-kill-top-levels)
     (sweeprolog-shutdown)
     t))