Improve documentation of 'electric-pair-mode'

* lisp/elec-pair.el (electric-pair-mode):
* doc/emacs/programs.texi (Matching): Document the operation of
electric-pair-mode when there's an active region.  (Bug#30502)
This commit is contained in:
Eli Zaretskii 2018-02-17 19:28:01 +02:00
parent f74ab96483
commit f138bca8ca
2 changed files with 16 additions and 8 deletions

View file

@ -877,12 +877,17 @@ or the last, non-whitespace position on the line.
@cindex inserting matching parentheses @cindex inserting matching parentheses
@findex electric-pair-mode @findex electric-pair-mode
Electric Pair mode, a global minor mode, provides a way to easily Electric Pair mode, a global minor mode, provides a way to easily
insert matching delimiters. Whenever you insert an opening delimiter, insert matching delimiters: parentheses, braces, brackets, etc.
the matching closing delimiter is automatically inserted as well, Whenever you insert an opening delimiter, the matching closing
leaving point between the two. Conversely, when you insert a closing delimiter is automatically inserted as well, leaving point between the
delimiter over an existing one, no inserting takes places and that two. Conversely, when you insert a closing delimiter over an existing
position is simply skipped over. These variables control additional one, no insertion takes places, and that position is simply skipped
features of Electric Pair mode: over. If the region is active (@pxref{Mark}), insertion of a
delimiter operates on the region: the characters in the region are
enclosed in a pair of matching delimiters, leaving point after the
delimiter you typed.
These variables control additional features of Electric Pair mode:
@itemize @bullet @itemize @bullet
@item @item

View file

@ -580,8 +580,11 @@ the mode if ARG is omitted or nil.
Electric Pair mode is a global minor mode. When enabled, typing Electric Pair mode is a global minor mode. When enabled, typing
an open parenthesis automatically inserts the corresponding an open parenthesis automatically inserts the corresponding
closing parenthesis. (Likewise for brackets, etc.). To toggle closing parenthesis, and vice versa. (Likewise for brackets, etc.).
the mode in a single buffer, use `electric-pair-local-mode'." If the region is active, the parentheses (brackets, etc.) are
inserted around the region instead.
To toggle the mode in a single buffer, use `electric-pair-local-mode'."
:global t :group 'electricity :global t :group 'electricity
(if electric-pair-mode (if electric-pair-mode
(progn (progn