]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/electric.el (electric-indent-mode): Clarify doc (bug#22564).
authorEli Zaretskii <eliz@gnu.org>
Sat, 14 May 2022 14:48:22 +0000 (17:48 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 14 May 2022 14:48:22 +0000 (17:48 +0300)
lisp/electric.el

index 042fc90ccbecb2495ce717d0ab59aa58a1edc793..4a35c1a2a144e65d8d096b5258ea2ce0dda2e91f 100644 (file)
@@ -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'."