From: Stefan Kangas <stefan@marxist.se>
Date: Tue, 5 Oct 2021 21:11:31 +0000 (+0200)
Subject: Clarify docstring of blink-matching-paren
X-Git-Tag: emacs-28.0.90~383
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b2c50d7cf36b8df931be0864f586cdf272886b11;p=emacs.git

Clarify docstring of blink-matching-paren

* lisp/simple.el (blink-matching-paren): Clarify
docstring.  (Bug#51032)
---

diff --git a/lisp/simple.el b/lisp/simple.el
index 36954151633..459fc679443 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -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)