summaryrefslogtreecommitdiff
path: root/lisp/emulation
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-09-26 16:50:11 +0300
committerEli Zaretskii <eliz@gnu.org>2021-09-26 16:50:11 +0300
commit5b44e0511a881593eb62ff1648be37ac1c728ecc (patch)
treee8f8d198e3086445a4502299480a64e3942360e5 /lisp/emulation
parentb8b1d8dee7e30415b057b7a45f288fda3601274f (diff)
downloademacs-5b44e0511a881593eb62ff1648be37ac1c728ecc.tar.gz
emacs-5b44e0511a881593eb62ff1648be37ac1c728ecc.tar.bz2
emacs-5b44e0511a881593eb62ff1648be37ac1c728ecc.zip
; Fix some recent fixes to doc strings
* lisp/whitespace.el (whitespace-empty-at-bob-regexp): * lisp/vc/vc-dir.el (vc-dir-child-files-and-states): * lisp/vc/vc-annotate.el (vc-annotate-show-changeset-diff-revision-at-line): * lisp/vc/ediff.el (ediff-merge-with-ancestor-command): * lisp/gnus/nnvirtual.el (nnvirtual-update-xref-header) (nnvirtual-map-article): * lisp/emulation/viper-init.el (viper-ESC-keyseq-timeout): * lisp/emulation/viper-cmd.el (viper-set-parsing-style-toggling-macro): * lisp/cedet/data-debug.el (data-debug-insert-hash-table-button): "The first line of a doc string must be a complete sentence." Also, fix some awkward wording in doc strings while at that.
Diffstat (limited to 'lisp/emulation')
-rw-r--r--lisp/emulation/viper-cmd.el8
-rw-r--r--lisp/emulation/viper-init.el5
2 files changed, 7 insertions, 6 deletions
diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el
index b132d786eb1..3fcc14c99d7 100644
--- a/lisp/emulation/viper-cmd.el
+++ b/lisp/emulation/viper-cmd.el
@@ -3546,11 +3546,11 @@ If MODE is set, set the macros only in that major mode."
(defun viper-set-parsing-style-toggling-macro (unset)
- "Set `%%%' to be a macro that toggles whether comment fields should be parsed
-for matching parentheses.
+ "Set or unset `%%%' as a macro that toggles comment parsing for parentheses.
This is used in conjunction with the `%' command.
-
-With a prefix argument, unsets the macro."
+By default, sets the macro which will toggle whether comment fields should
+be parsed for matching parentheses. With a prefix argument, unsets the
+macro instead."
(interactive "P")
(or noninteractive
(if (not unset)
diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el
index ffcb4602e73..fe3704841ac 100644
--- a/lisp/emulation/viper-init.el
+++ b/lisp/emulation/viper-init.el
@@ -932,8 +932,9 @@ Should be set in `viper-custom-file-name'."
(setq cursor-type '(bar . 2)))
(defun viper-ESC-keyseq-timeout ()
- "Key sequence beginning with ESC and separated by no more than this many
-milliseconds is considered to be generated by a keyboard function key.
+ "Return the timeout for considering an ESC sequence to be a function key.
+Sequences of keys beginning with ESC and separated by no more than this many
+milliseconds are considered to be generated by a keyboard function key.
Setting this too high may slow down switching from insert to vi state. Setting
this value too low will make it impossible to use function keys in insert mode
on a dumb terminal."