]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify docstring of blink-matching-paren
authorStefan Kangas <stefan@marxist.se>
Tue, 5 Oct 2021 21:11:31 +0000 (23:11 +0200)
committerStefan Kangas <stefan@marxist.se>
Tue, 5 Oct 2021 21:11:31 +0000 (23:11 +0200)
* lisp/simple.el (blink-matching-paren): Clarify
docstring.  (Bug#51032)

lisp/simple.el

index 369541516333941467e42f5037f4e7c17914f8ed..459fc67944365c751a4df7ed2c06306c0c1b9420 100644 (file)
@@ -8419,11 +8419,16 @@ presented."
 
 (defcustom blink-matching-paren t
   "Non-nil means show matching open-paren when close-paren is inserted.
-If t, highlight the paren.  If `jump', briefly move cursor to its
-position.  If `jump-offscreen', move cursor there even if the
-position is off screen.  With any other non-nil value, the
-off-screen position of the opening paren will be shown in the
-echo area."
+In addition, if the opening paren is not visible on screen, show
+its position in the echo area.
+
+The valid values are:
+
+  nil               Disable.
+  non-nil           Highlight the opening paren.
+  `jump'            Briefly move cursor to its position.
+  `jump-offscreen'  Briefly move cursor to its position,
+                    even if the opening paren is not on screen."
   :type '(choice
           (const :tag "Disable" nil)
           (const :tag "Highlight" t)