bug#46702: Link symbol name in Help

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

>   Its value is ‘grow-only’
>
>     You can customize this variable.
>     This variable was introduced, or its default value was changed, in
>     version 25.1 of Emacs.
>     Probably introduced at or before Emacs version 21.1.
>
>   How to resize mini-windows (the minibuffer and the echo area).
>   A value of nil means don’t automatically resize mini-windows.
>   A value of t means resize them to fit the text displayed in them.
>   A value of ‘grow-only’, the default, means let mini-windows grow only;
>   they return to their normal size when the minibuffer is closed, or the
>   echo area becomes empty.
>
> The "How to resize mini-windows..." part begins "out of the blue".
> It's actually incorrect English (incomplete sentence), AFAIK.  It
> reads okay-ish when the first line is alone, or when the text follows
> some heading, like "Documentation:", but that is gone now.

I don't think the "Documentation:" line helps much here, though.  It's
just an awkward first line.

We've previously discussed rearranging the function/variable output in a
more "readerly" way -- for instance, it's odd that the block of indented
things come before the doc string, because those indented things aren't
what's most vital for normal users to know.

But even if the buffer started with:

  resize-mini-windows is a variable defined in ‘C source code’.

  How to resize mini-windows (the minibuffer and the echo area).
  A value of nil means don’t automatically resize mini-windows.

It'd still be an awkward doc string, because it's just an awkward
semi-sentence.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no