]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify indent-line-function doc string
authorEli Zaretskii <eliz@gnu.org>
Sun, 30 May 2021 04:11:02 +0000 (06:11 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 30 May 2021 04:11:02 +0000 (06:11 +0200)
* lisp/indent.el (indent-line-function): Clarify by avoiding
specifics (bug#20846).

lisp/indent.el

index 285b8e2038fd205964978259a1c0b3cd4ed9fd03..a33d9620098112706971594cc8288068df4516c7 100644 (file)
@@ -39,8 +39,8 @@
 (defvar indent-line-function 'indent-relative
   "Function to indent the current line.
 This function will be called with no arguments.
-If it is called somewhere where auto-indentation cannot be done
-\(e.g. inside a string), the function should simply return `noindent'.
+If it is called somewhere where it cannot auto-indent, the function
+should return `noindent' to signal that it didn't.
 Setting this function is all you need to make TAB indent appropriately.
 Don't rebind TAB unless you really need to.")