Re: MINI-PATCH: add how to turn auto-completion in test buffers off

[Eli Zaretskii]

> From: Pedro Andres Aranda Gutierrez <paaguti@gmail.com>
> Date: Fri, 5 Apr 2024 12:25:18 +0200
> Cc: emacs-devel@gnu.org
> 
> so you mean something like the attached patch?

Almost, see below.

> diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi
> index cb347d59948..f039c42d46c 100644
> --- a/doc/emacs/text.texi
> +++ b/doc/emacs/text.texi
> @@ -954,6 +954,11 @@ Text Mode
>    Entering Text mode runs the mode hook @code{text-mode-hook}
>  (@pxref{Major Modes}).
>  
> +@vindex text-mode-ispell-word-completion
> +  Entering Text mode also activates auto-complete hints. If you find
> +that this is disturbing for you, set this variable to @code{nil} in
> +your Emacs initialization code.

This is using the wrong tone for describing the issue: it regards
completion hints in Text Mode as a nuisance in most cases.  If it were
such a nuisance, we ought to make it off by default.

Instead, the text should describe the completion hints feature from
the POV of its being useful, and then say that the variable
text-mode-ispell-word-completion controls it.

Also, @vindex generates no text in the formatted manual, so you need
to mention the variable in the text as well, otherwise "this variable"
will allude to something the text doesn't mention.

Finally, please leave two spaces between sentences, per our
conventions.

> --- a/lisp/textmodes/text-mode.el
> +++ b/lisp/textmodes/text-mode.el
> @@ -145,7 +145,10 @@ text-mode
>  You can thus get the full benefit of adaptive filling
>   (see the variable `adaptive-fill-mode').
>  \\{text-mode-map}
> -Turning on Text mode runs the normal hook `text-mode-hook'."
> +Turning on Text mode runs the normal hook `text-mode-hook'.
> +By default, `text-mode-hook' will enable completion at point with
> +candidates supplied by `ispell'. You can turn this off by
> +setting `text-mode-ispell-word-completion' to `nil'."

This part is okay (modulo the 2 spaces between sentences issue).

Thanks.