Subject: PATCH for docstrings for preview
From: Jeremy Bryant <[email-masked]>
To: [email-masked]
Date: Tue, 28 May 2024 18:57:20 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

Here is a patch for checkdoc fixes for preview.el

From f0195452b77298e2150f547b18ec913bad3c24a4 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <[email-masked]>
Date: Tue, 28 May 2024 18:53:08 +0100
Subject: [PATCH] ; Checkdoc fixes for interactive commands

* preview.el.in (preview-copy-region-as-mml): Add docstring.
(preview-install-styles): Add arg in docstring, and
add checkdoc fix for prompt.
---
 preview.el.in | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/preview.el.in b/preview.el.in
index e8c2c695..9404bc94 100644
--- a/preview.el.in
+++ b/preview.el.in
@@ -2881,6 +2881,7 @@ using MML mode."
       (preview-regenerate ov))))
 
 (defun preview-copy-region-as-mml (start end)
+  "Copy into kill ring an MML representation of region from START to END."
   (interactive "r")
   (when (catch 'badcolor
           (let (str lst dont-ask)
@@ -3048,7 +3049,7 @@ changes get properly reflected in the environment."
 ;;;###autoload
 (defun preview-install-styles (dir &optional force-overwrite
                                    force-save)
-  "Installs the TeX style files into a permanent location.
+  "Install the TeX style files into a permanent location DIR.
 This must be in the TeX search path.  If FORCE-OVERWRITE is greater
 than 1, files will get overwritten without query, if it is less
 than 1 or nil, the operation will fail.  The default of 1 for interactive
@@ -3077,7 +3078,7 @@ pp")
                                (> force-overwrite 1))
                               (t force-overwrite))))
   (if (cond ((eq force-save 1)
-             (y-or-n-p "Stop using non-installed styles permanently "))
+             (y-or-n-p "Stop using non-installed styles permanently? "))
             ((numberp force-save)
              (> force-save 1))
             (t force-save))
-- 
2.42.0