bug#38601: describe-mode never says the most important thing

[Stefan Kangas]

tags 38601 notabug
close 38601
thanks

Eli Zaretskii <eliz@gnu.org> writes:

>> From: 積丹尼 Dan Jacobson
>>  <jidanni@jidanni.org>
>> Date: Sat, 14 Dec 2019 07:29:31 +0800
>>
>>   ^L
>>   Electric-Indent minor mode (no indicator):
>>   Toggle on-the-fly reindentation (Electric Indent mode).
>>   With a prefix argument ARG, enable Electric Indent mode if ARG is
>>   positive, and disable it otherwise.  If called from Lisp, enable
>>   the mode if ARG is omitted or nil.
>>
>>   When enabled, this reindents whenever the hook ‘electric-indent-functions’
>>   returns non-nil, or if you insert a character from ‘electric-indent-chars’.
>>
>>   This is a global minor mode.  To toggle the mode in a single buffer,
>>   use ‘electric-indent-local-mode’.
>>   ^L
>>
>> The problem is, it doesn't mention how to turn it on and off!
>
> Actually, it does: that's the last sentence above.
>
>> The user has to click on each line right after an ^L, to learn that he
>> simply needs to do e.g.,
>>
>>   (electric-indent-mode &optional ARG)
>
> That's not a user command, that's a Lisp way of doing this stuff, and
> therefore doesn't have to be anywhere near the beginning of the help
> text.
>
> So I think we should close this as a non-b ug.

OK, closing.