Subject: bug#71532: closed (Re: bug#71532: [PATCH] 30.0.50; Fix some docstrings in ispell.el)

From: [email-masked] (GNU bug Tracking System)
Date: Sat, 15 Jun 2024 12:04:02 +0000

Your bug report

#71532: [PATCH] 30.0.50; Fix some docstrings in ispell.el

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
71532: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=71532
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#71532: [PATCH] 30.0.50; Fix some docstrings in ispell.el
From: Eli Zaretskii <[email-masked]>
To: Arash Esbati <[email-masked]>
Cc: [email-masked]
Date: Sat, 15 Jun 2024 15:03:15 +0300
List-Id: <debbugs-submit.debbugs.gnu.org>

> From: Arash Esbati <[email-masked]>
> Cc: [email-masked]
> Date: Thu, 13 Jun 2024 14:43:43 +0200
> 
> Eli Zaretskii <[email-masked]> writes:
> 
> > Thanks, see some comments below.
> 
> Thanks for your comments, next try is attached.

Installed, with a slight fix.

> > Please show the messages if you have them handy.
> 
> --8<---------------cut here---------------start------------->8---
> *** ispell.el: checkdoc-start

Thanks, I tried to fix those.

Subject: [PATCH] 30.0.50; Fix some docstrings in ispell.el
From: Arash Esbati <[email-masked]>
To: "emacs-bugs" <[email-masked]>
Date: Thu, 13 Jun 2024 11:51:04 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

Hi all,

please find attached a trivial patch fixing some docstrings in
ispell.el.  `checkdoc-minor-mode' reports more, but I didn't try to
understand the code in order to fix the rest as well.

Best, Arash
>From cdf1fcacca5dab0e1277f901a86d4b9e334c71ca Mon Sep 17 00:00:00 2001
From: Arash Esbati <[email-masked]>
Date: Thu, 13 Jun 2024 11:46:09 +0200
Subject: [PATCH] ; Fix some docstrings.

---
 lisp/textmodes/ispell.el | 33 ++++++++++++++++++---------------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el
index f523df9881e..3c8ed1d30d7 100644
--- a/lisp/textmodes/ispell.el
+++ b/lisp/textmodes/ispell.el
@@ -219,8 +219,9 @@ ispell-alternate-dictionary
   :type '(choice file (const :tag "None" nil)))
 
 (defcustom ispell-complete-word-dict nil
-  "Plain word-list dictionary used for word completion if
-different from `ispell-alternate-dictionary'.
+  "Plain word-list dictionary used for word completion.
+This word-list is used if it is different from
+`ispell-alternate-dictionary'.
 This is also used by `ispell-lookup-words' and `ispell-complete-word'."
   :type '(choice file (const :tag "None" nil)))
 
@@ -639,8 +640,8 @@ ispell-dicts-name2locale-equivs-alist
     ("slovenian"     "sl_SI")
     ("svenska"       "sv_SE")
     ("hebrew"        "he_IL"))
-  "Alist with known matching locales for standard dict names in
-`ispell-dictionary-base-alist'.")
+  "Alist with known matching locales for standard dict names.
+Standard dict names are defined in `ispell-dictionary-base-alist'.")

 ;;; **********************************************************************
@@ -759,14 +760,16 @@ ispell-with-safe-default-directory
      ,@body))
 
 (defun ispell-call-process (&rest args)
-  "Like `call-process', but defend against bad `default-directory'."
+  "Like `call-process', but defend against bad `default-directory'.
+ARGS are passed to `call-process'."
   (ispell-with-safe-default-directory
-    (apply 'call-process args)))
+    (apply #'call-process args)))
 
 (defun ispell-call-process-region (&rest args)
-  "Like `call-process-region', but defend against bad `default-directory'."
+  "Like `call-process-region', but defend against bad `default-directory'.
+ARGS are passed to `call-process'."
   (ispell-with-safe-default-directory
-    (apply 'call-process-region args)))
+    (apply #'call-process-region args)))
 
 (defvar ispell-debug-buffer)
 
@@ -856,10 +859,9 @@ ispell-get-aspell-config-value
     (car (split-string (buffer-string)))))
 
 (defun ispell-aspell-find-dictionary (dict-name)
-  "For Aspell dictionary DICT-NAME, return a list of parameters if an
-associated data file is found or nil otherwise.  List format is that
-of `ispell-dictionary-base-alist' elements."
-
+  "For Aspell dictionary DICT-NAME, return a list of parameters or nil.
+List format is that of `ispell-dictionary-base-alist' elements if an
+associated data file is found."
   ;; Make sure `ispell-aspell-dict-dir' is defined
   (or ispell-aspell-dict-dir
       (setq ispell-aspell-dict-dir
@@ -1607,8 +1609,8 @@ ispell-parsing-keyword
 The last occurring definition in the buffer will be used.")
 
 (defun ispell--\\w-filter (char)
-  "Return CHAR in a string when CHAR doesn't have \"word\" syntax,
-nil otherwise.  CHAR must be a character."
+  "Return CHAR in a string when CHAR doesn't have \"word\" syntax or nil.
+CHAR must be a character."
   (let ((str (string char)))
     (and
      (not (string-match "\\w" str))
@@ -3868,7 +3870,8 @@ ispell-message-text-end

 (defun ispell-mime-multipartp (&optional limit)
-  "Return multipart message start boundary or nil if none."
+  "Return multipart message start boundary or nil if none.
+LIMIT is passed to `re-search-forward', which see."
   ;; caller must ensure `case-fold-search' is set to t
   (and
    (re-search-forward
-- 
2.45.2