Skip to content

Commit

Permalink
Clarify docstring of blink-matching-paren
Browse files Browse the repository at this point in the history
* lisp/simple.el (blink-matching-paren): Clarify
docstring.  (Bug#51032)
  • Loading branch information
skangas committed Oct 5, 2021
1 parent d2a34ca commit b2c50d7
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions lisp/simple.el
Expand Up @@ -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)
Expand Down

0 comments on commit b2c50d7

Please sign in to comment.