summaryrefslogtreecommitdiff
path: root/lisp/indent.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-05-30 06:11:02 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2021-05-30 06:11:02 +0200
commita4c922d84f3fb92cbccc37f69370b016250a88cd (patch)
treebffc1dfd1b8704893c55a85cfe6f74de31d37087 /lisp/indent.el
parentc97716e9a201c8b5fe0aad414f1846ace878258e (diff)
Clarify indent-line-function doc string
* lisp/indent.el (indent-line-function): Clarify by avoiding specifics (bug#20846).
Diffstat (limited to 'lisp/indent.el')
-rw-r--r--lisp/indent.el4
1 files changed, 2 insertions, 2 deletions
diff --git a/lisp/indent.el b/lisp/indent.el
index 285b8e2038f..a33d9620098 100644
--- a/lisp/indent.el
+++ b/lisp/indent.el
@@ -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.")