Checkdoc fixes in textmodes/*.el
* 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.
This commit is contained in:
parent
e19fd6a22d
commit
336aa6ab17
7 changed files with 25 additions and 24 deletions
|
@ -2416,7 +2416,7 @@ Global `ispell-quit' is set to start location to continue spell session."
|
||||||
(progn
|
(progn
|
||||||
(set-marker ispell-recursive-edit-marker nil)
|
(set-marker ispell-recursive-edit-marker nil)
|
||||||
(error
|
(error
|
||||||
"Cannot continue ispell from this buffer.")))
|
"Cannot continue ispell from this buffer")))
|
||||||
(set-marker ispell-recursive-edit-marker nil)))
|
(set-marker ispell-recursive-edit-marker nil)))
|
||||||
(list word nil)) ; recheck starting at this word.
|
(list word nil)) ; recheck starting at this word.
|
||||||
((= char ?\C-z)
|
((= char ?\C-z)
|
||||||
|
|
|
@ -86,7 +86,7 @@ code();
|
||||||
"Regexp matching the prefix of buffer-locals we want to capture.")
|
"Regexp matching the prefix of buffer-locals we want to capture.")
|
||||||
|
|
||||||
(defun mhtml--construct-submode (mode &rest args)
|
(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)
|
(let ((captured-locals nil)
|
||||||
(crucial-captured-locals nil)
|
(crucial-captured-locals nil)
|
||||||
(submode (apply #'make-mhtml--submode args)))
|
(submode (apply #'make-mhtml--submode args)))
|
||||||
|
|
|
@ -486,7 +486,7 @@ contain matches to the regexp.)")
|
||||||
|
|
||||||
(define-obsolete-function-alias 'set-page-delimiter #'pages-set-delimiter "27.1")
|
(define-obsolete-function-alias 'set-page-delimiter #'pages-set-delimiter "27.1")
|
||||||
(defun pages-set-delimiter (regexp reset-p &optional interactively)
|
(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
|
Called interactively with a prefix argument, reset `page-delimiter' to
|
||||||
its original value.
|
its original value.
|
||||||
|
|
||||||
|
|
|
@ -270,13 +270,13 @@ This is in addition to the `r2b-capitalize-title-stop-words'.")
|
||||||
(princ (apply (function format) args) r2b-out-buf))
|
(princ (apply (function format) args) r2b-out-buf))
|
||||||
|
|
||||||
(defun r2b-get-field (var field &optional unique required capitalize)
|
(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
|
"Set VAR to string value of FIELD, if any.
|
||||||
nil. If multiple fields appear, then separate values with the
|
If none, VAR is set to nil. If multiple fields appear, then separate
|
||||||
'\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning
|
values with the '\\nand\\t\\t', unless UNIQUE is non-nil, in which case
|
||||||
and just concatenate the values. Trim off leading blanks and tabs on
|
log a warning and just concatenate the values. Trim off leading blanks
|
||||||
first line, and trailing blanks and tabs of every line. Log a warning
|
and tabs on first line, and trailing blanks and tabs of every line. Log
|
||||||
and set VAR to the empty string if REQUIRED is true. Capitalize as a
|
a warning and set VAR to the empty string if REQUIRED is true.
|
||||||
title if CAPITALIZE is true. Returns value of VAR."
|
Capitalize as a title if CAPITALIZE is true. Return value of VAR."
|
||||||
(let (item val (not-past-end t))
|
(let (item val (not-past-end t))
|
||||||
(r2b-trace "snarfing %s" field)
|
(r2b-trace "snarfing %s" field)
|
||||||
(goto-char (point-min))
|
(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)
|
(defun r2b-put-field (field data &optional abbrevs)
|
||||||
"Print bibtex FIELD = {DATA} if DATA not null; precede
|
"Print bibtex FIELD = {DATA} if DATA not null; precede with comma and newline.
|
||||||
with a comma and newline; if ABBREVS list is given, then
|
|
||||||
try to replace the {DATA} with an abbreviation."
|
If ABBREVS list is given, then try to replace the {DATA} with an
|
||||||
|
abbreviation."
|
||||||
(if data
|
(if data
|
||||||
(let (match nodelim index) ;; multi-line
|
(let (match nodelim index) ;; multi-line
|
||||||
(cond
|
(cond
|
||||||
|
|
|
@ -113,9 +113,9 @@ each time it is needed."
|
||||||
|
|
||||||
(defcustom refer-cache-bib-files t
|
(defcustom refer-cache-bib-files t
|
||||||
"Variable determining whether the value of `refer-bib-files' should be cached.
|
"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
|
If t, initialize the value of refer-bib-files the first time it is used.
|
||||||
nil, re-read the list of \\.bib files depending on the value of `refer-bib-files'
|
If nil, re-read the list of \\.bib files depending on the value of
|
||||||
each time it is needed."
|
`refer-bib-files' each time it is needed."
|
||||||
:type 'boolean)
|
:type 'boolean)
|
||||||
|
|
||||||
(defcustom refer-bib-files-regexp "\\\\bibliography"
|
(defcustom refer-bib-files-regexp "\\\\bibliography"
|
||||||
|
|
|
@ -1263,7 +1263,7 @@ This gets refreshed in every phrases command.")
|
||||||
(defun reftex-index-phrase-selection-or-word (arg)
|
(defun reftex-index-phrase-selection-or-word (arg)
|
||||||
"Add current selection or word at point to the phrases buffer.
|
"Add current selection or word at point to the phrases buffer.
|
||||||
\\<reftex-index-phrases-mode-map>
|
\\<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.
|
selection will be used - otherwise the word at point.
|
||||||
You get a chance to edit the entry in the phrases buffer - finish with
|
You get a chance to edit the entry in the phrases buffer - finish with
|
||||||
\\[reftex-index-phrases-save-and-return]."
|
\\[reftex-index-phrases-save-and-return]."
|
||||||
|
@ -1364,8 +1364,8 @@ If the buffer is non-empty, delete the old header first."
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(define-derived-mode reftex-index-phrases-mode fundamental-mode "Phrases"
|
(define-derived-mode reftex-index-phrases-mode fundamental-mode "Phrases"
|
||||||
"Major mode for managing the Index phrases of a LaTeX document.
|
"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
|
To insert new phrases, use
|
||||||
- `C-c \\' in the LaTeX document to copy selection or word
|
- `C-c \\' in the LaTeX document to copy selection or word
|
||||||
- `\\[reftex-index-new-phrase]' in the phrases buffer.
|
- `\\[reftex-index-new-phrase]' in the phrases buffer.
|
||||||
|
|
|
@ -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
|
M-9 \\[table-widen-cell] (or \\[universal-argument] 9 \\[table-widen-cell]) widens the first cell by 9 character
|
||||||
width, which results as
|
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
|
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)
|
(defun table--fill-region-strictly (beg end)
|
||||||
"Fill region strictly so that no line exceeds `fill-column'.
|
"Fill region strictly so that no line exceeds `fill-column'.
|
||||||
When a word exceeds fill-column the word is chopped into pieces. The
|
When a word exceeds `fill-column' the word is chopped into pieces. The
|
||||||
chopped location is indicated with table-word-continuation-char."
|
chopped location is indicated with `table-word-continuation-char'."
|
||||||
(or (and (markerp beg) (markerp end))
|
(or (and (markerp beg) (markerp end))
|
||||||
(error "markerp"))
|
(error "markerp"))
|
||||||
(if (< fill-column 2)
|
(if (< fill-column 2)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue