From: Mike Kupfer <mkupfer@alum.berkeley.edu>
Date: Tue, 16 Nov 2021 05:55:53 +0000 (-0800)
Subject: Fix checkdoc complaints in MH-E
X-Git-Tag: emacs-29.0.90~2852^2~265
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cb0aa89bcfb801ec2737e9b1a534bb87d3363dd9;p=emacs.git

Fix checkdoc complaints in MH-E

* lisp/mh-e/mh-compat.el (mh-flet): Rewrite most of the docstring.
(mh-write-file-functions): Remove trailing space.
* lisp/mh-e-mh-scan.el (mh-scan-cmd-note-width): Break up a
line that was too long.
---

diff --git a/lisp/mh-e/mh-compat.el b/lisp/mh-e/mh-compat.el
index 19be5afd790..23dc48a574c 100644
--- a/lisp/mh-e/mh-compat.el
+++ b/lisp/mh-e/mh-compat.el
@@ -46,10 +46,9 @@
 ;; cl-letf. This macro is based upon gmm-flet from Gnus.
 (defmacro mh-flet (bindings &rest body)
   "Make temporary overriding function definitions.
-This is an analogue of a dynamically scoped `let' that operates on
-the function cell of FUNCs rather than their value cell.
-
-\(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
+That is, temporarily rebind the functions listed in BINDINGS and then
+execute BODY.  BINDINGS is a list containing one or more lists of the
+form (FUNCNAME ARGLIST BODY...), similar to defun."
   (declare (indent 1) (debug ((&rest (sexp sexp &rest form)) &rest form)))
   (if (fboundp 'cl-letf)
       `(cl-letf ,(mapcar (lambda (binding)
@@ -138,7 +137,7 @@ This is taken from RFC 2396.")
   #'window-full-height-p "29.1")
 
 (defmacro mh-write-file-functions ()
-  "Return `write-file-functions'. "
+  "Return `write-file-functions'."
   (declare (obsolete nil "29.1"))
   ''write-file-functions)
 
diff --git a/lisp/mh-e/mh-scan.el b/lisp/mh-e/mh-scan.el
index bf3cfeff5cb..9ac251e8b71 100644
--- a/lisp/mh-e/mh-scan.el
+++ b/lisp/mh-e/mh-scan.el
@@ -327,7 +327,11 @@ Note that columns in Emacs start with 0.")
 (defvar mh-scan-cmd-note-width 1
   "Number of columns consumed by the cmd-note field in `mh-scan-format'.
 
-This column will have one of the values: \" \", \"^\", \"D\", \"B\", \"A\", \"+\", where
+This column will have one of the values:
+
+  \" \", \"^\", \"D\", \"B\", \"A\", \"+\"
+
+where
 
   \" \" is the default value,
   \"^\" is the `mh-note-refiled' character,