]> git.eshelyaron.com Git - emacs.git/commitdiff
Checkdoc fixes in `textmodes/*.el`
authorStefan Kangas <stefankangas@gmail.com>
Mon, 8 Jul 2024 15:16:32 +0000 (17:16 +0200)
committerEshel Yaron <me@eshelyaron.com>
Tue, 9 Jul 2024 17:50:23 +0000 (19:50 +0200)
* lisp/textmodes/ispell.el (ispell-command-loop):
* lisp/textmodes/mhtml-mode.el (mhtml--construct-submode):
* lisp/textmodes/page-ext.el (pages-set-delimiter):
* lisp/textmodes/refbib.el (r2b-get-field, r2b-put-field):
* lisp/textmodes/refer.el (refer-cache-bib-files):
* lisp/textmodes/reftex-index.el (reftex-index-phrase-selection-or-word):
(reftex-index-phrases-mode):
* lisp/textmodes/table.el (table-insert, table--fill-region-strictly):
Checkdoc fixes.

(cherry picked from commit 336aa6ab17a25351d54bb66fb66939ca27a6e94a)

lisp/textmodes/ispell.el
lisp/textmodes/mhtml-mode.el
lisp/textmodes/page-ext.el
lisp/textmodes/refbib.el
lisp/textmodes/refer.el
lisp/textmodes/reftex-index.el
lisp/textmodes/table.el

index caf59995c0123839628fa4461e6a083e33c166fb..667da10d7a308c54c173c5b82a2293f8b5bb55e5 100644 (file)
@@ -2416,7 +2416,7 @@ Global `ispell-quit' is set to start location to continue spell session."
                            (progn
                              (set-marker ispell-recursive-edit-marker nil)
                              (error
-                              "Cannot continue ispell from this buffer.")))
+                               "Cannot continue ispell from this buffer")))
                        (set-marker ispell-recursive-edit-marker nil)))
                    (list word nil))    ; recheck starting at this word.
                   ((= char ?\C-z)
index e2de6959dc682f118420cc401761d9df8b951836..987d3d7345c96c8c3026233bf733fbfd40956a81 100644 (file)
@@ -86,7 +86,7 @@ code();
   "Regexp matching the prefix of buffer-locals we want to capture.")
 
 (defun mhtml--construct-submode (mode &rest args)
-  "A wrapper for make-mhtml--submode that computes the buffer-local variables."
+  "A wrapper for `make-mhtml--submode' that computes the buffer-local variables."
   (let ((captured-locals nil)
         (crucial-captured-locals nil)
         (submode (apply #'make-mhtml--submode args)))
index f5f59adb0cff7fabab195980bdd3b1b7d362d6f8..1681f86b343348450ac626450550e69deff0e0d5 100644 (file)
@@ -486,7 +486,7 @@ contain matches to the regexp.)")
 
 (define-obsolete-function-alias 'set-page-delimiter #'pages-set-delimiter "27.1")
 (defun pages-set-delimiter (regexp reset-p &optional interactively)
-  "Set buffer local value of page-delimiter to REGEXP.
+  "Set buffer local value of `page-delimiter' to REGEXP.
 Called interactively with a prefix argument, reset `page-delimiter' to
 its original value.
 
index dd548e00d9b1553124119e52ccd45399358226e1..087e097649ef056d8cb4c21347f1608343a71239 100644 (file)
@@ -270,13 +270,13 @@ This is in addition to the `r2b-capitalize-title-stop-words'.")
    (princ (apply (function format) args) r2b-out-buf))
 
 (defun r2b-get-field (var field &optional unique required capitalize)
-   "Set VAR to string value of FIELD, if any.  If none, VAR is set to
-nil.  If multiple fields appear, then separate values with the
-'\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning
-and just concatenate the values.  Trim off leading blanks and tabs on
-first line, and trailing blanks and tabs of every line.  Log a warning
-and set VAR to the empty string if REQUIRED is true.  Capitalize as a
-title if CAPITALIZE is true.  Returns value of VAR."
+   "Set VAR to string value of FIELD, if any.
+If none, VAR is set to nil.  If multiple fields appear, then separate
+values with the '\\nand\\t\\t', unless UNIQUE is non-nil, in which case
+log a warning and just concatenate the values.  Trim off leading blanks
+and tabs on first line, and trailing blanks and tabs of every line.  Log
+a warning and set VAR to the empty string if REQUIRED is true.
+Capitalize as a title if CAPITALIZE is true.  Return value of VAR."
    (let (item val (not-past-end t))
       (r2b-trace "snarfing %s" field)
       (goto-char (point-min))
@@ -406,9 +406,10 @@ title if CAPITALIZE is true.  Returns value of VAR."
 
 
 (defun r2b-put-field (field data &optional abbrevs)
-  "Print bibtex FIELD = {DATA} if DATA not null; precede
-with a comma and newline; if ABBREVS list is given, then
-try to replace the {DATA} with an abbreviation."
+  "Print bibtex FIELD = {DATA} if DATA not null; precede with comma and newline.
+
+If ABBREVS list is given, then try to replace the {DATA} with an
+abbreviation."
   (if data
     (let (match nodelim index) ;; multi-line
       (cond
index 0fbe4a30b11fc538a0b0399d36bc2acaf585c78a..f5f4be75c03e84687c4055c87d579953488575d6 100644 (file)
@@ -113,9 +113,9 @@ each time it is needed."
 
 (defcustom refer-cache-bib-files t
   "Variable determining whether the value of `refer-bib-files' should be cached.
-If t, initialize the value of refer-bib-files the first time it is used.  If
-nil, re-read the list of \\.bib files depending on the value of `refer-bib-files'
-each time it is needed."
+If t, initialize the value of refer-bib-files the first time it is used.
+If nil, re-read the list of \\.bib files depending on the value of
+`refer-bib-files' each time it is needed."
   :type 'boolean)
 
 (defcustom refer-bib-files-regexp "\\\\bibliography"
index db476ff5c0b4aa7fa5716d85b25824d727856ca2..cb491367c8ddcf331d6ca6e1d1561ce0f5fa2e86 100644 (file)
@@ -1263,7 +1263,7 @@ This gets refreshed in every phrases command.")
 (defun reftex-index-phrase-selection-or-word (arg)
   "Add current selection or word at point to the phrases buffer.
 \\<reftex-index-phrases-mode-map>
-When you are in transient-mark-mode and the region is active, the
+When you are in `transient-mark-mode' and the region is active, the
 selection will be used - otherwise the word at point.
 You get a chance to edit the entry in the phrases buffer - finish with
 \\[reftex-index-phrases-save-and-return]."
@@ -1363,8 +1363,8 @@ If the buffer is non-empty, delete the old header first."
 ;;;###autoload
 (define-derived-mode reftex-index-phrases-mode fundamental-mode "Phrases"
   "Major mode for managing the Index phrases of a LaTeX document.
-This buffer was created with RefTeX. \\<reftex-index-phrases-mode-map>
-
+This buffer was created with RefTeX.
+\\<reftex-index-phrases-mode-map>
 To insert new phrases, use
  - `C-c \\' in the LaTeX document to copy selection or word
  - `\\[reftex-index-new-phrase]' in the phrases buffer.
index 2087fd8271b45329af5fcb96d083590301b9b6db..918c84bc9490a8086ca32de358c409fcbf0a74f2 100644 (file)
@@ -1456,8 +1456,8 @@ first cell.
     |-!-  |     |     |
     +-----+-----+-----+
 
-Inside a table cell, there are special key bindings. \\<table-cell-map>
-
+Inside a table cell, there are special key bindings.
+\\<table-cell-map>
 M-9 \\[table-widen-cell] (or \\[universal-argument] 9 \\[table-widen-cell]) widens the first cell by 9 character
 width, which results as
 
@@ -1466,7 +1466,7 @@ width, which results as
     +--------------+-----+-----+
 
 Type TAB \\[table-widen-cell] then type TAB M-2 M-7 \\[table-widen-cell] (or \\[universal-argument] 2 7 \\[table-widen-cell]).  Typing
-TAB moves the point forward by a cell. The result now looks like this:
+TAB moves the point forward by a cell.  The result now looks like this:
 
     +--------------+------+--------------------------------+
     |              |      |-!-                             |
@@ -5301,8 +5301,8 @@ Current buffer must already be set to the cache buffer."
 
 (defun table--fill-region-strictly (beg end)
   "Fill region strictly so that no line exceeds `fill-column'.
-When a word exceeds fill-column the word is chopped into pieces.  The
-chopped location is indicated with table-word-continuation-char."
+When a word exceeds `fill-column' the word is chopped into pieces.  The
+chopped location is indicated with `table-word-continuation-char'."
   (or (and (markerp beg) (markerp end))
       (error "markerp"))
   (if (< fill-column 2)