summaryrefslogtreecommitdiff
path: root/lisp/electric.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-05-14 17:48:22 +0300
committerEli Zaretskii <eliz@gnu.org>2022-05-14 17:48:22 +0300
commit8370caa835372ba7841e3822b0f929398c074e1a (patch)
tree72b3330b8d8f4b919f6c4f483e6b91cea407c4c3 /lisp/electric.el
parentf044da7704edfc7e6cf32606328d0735b77e60d9 (diff)
downloademacs-8370caa835372ba7841e3822b0f929398c074e1a.tar.gz
; * lisp/electric.el (electric-indent-mode): Clarify doc (bug#22564).
Diffstat (limited to 'lisp/electric.el')
-rw-r--r--lisp/electric.el10
1 files changed, 8 insertions, 2 deletions
diff --git a/lisp/electric.el b/lisp/electric.el
index 042fc90ccbe..4a35c1a2a14 100644
--- a/lisp/electric.el
+++ b/lisp/electric.el
@@ -310,10 +310,16 @@ column specified by the function `current-left-margin'."
;;;###autoload
(define-minor-mode electric-indent-mode
- "Toggle on-the-fly reindentation (Electric Indent mode).
+ "Toggle on-the-fly reindentation of text lines (Electric Indent mode).
When enabled, this reindents whenever the hook `electric-indent-functions'
-returns non-nil, or if you insert a character from `electric-indent-chars'.
+returns non-nil, or if you insert one of the \"electric characters\".
+The electric characters normally include the newline, but can
+also include other characters as needed by the major mode; see
+`electric-indent-chars' for the actual list.
+
+By \"reindent\" we mean remove any existing indentation, and then
+indent the line accordiung to context and rules of the major mode.
This is a global minor mode. To toggle the mode in a single buffer,
use `electric-indent-local-mode'."