Clarify docstring of blink-matching-paren

* lisp/simple.el (blink-matching-paren): Clarify
docstring.  (Bug#51032)
This commit is contained in:
Stefan Kangas 2021-10-05 23:11:31 +02:00
parent d2a34cabcf
commit b2c50d7cf3

View file

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