* 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)
(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)
"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)))
(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.
(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))
(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
(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"
(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]."
;;;###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.
|-!- | | |
+-----+-----+-----+
-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
+--------------+-----+-----+
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:
+--------------+------+--------------------------------+
| | |-!- |
(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)