From: Lars Ingebrigtsen <larsi@gnus.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: laszlomail@protonmail.com, 46702@debbugs.gnu.org
Subject: bug#46702: Link symbol name in Help
Date: Thu, 25 Feb 2021 16:15:03 +0100 [thread overview]
Message-ID: <87tuq041s8.fsf@gnus.org> (raw)
In-Reply-To: <837dmxtmz1.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 24 Feb 2021 19:05:54 +0200")
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
next prev parent reply other threads:[~2021-02-25 15:15 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-22 6:05 bug#46702: Link symbol name in Help Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-22 8:21 ` Andreas Schwab
2021-02-22 8:26 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-22 8:38 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-22 15:01 ` Lars Ingebrigtsen
2021-02-22 15:55 ` Eli Zaretskii
2021-02-22 21:34 ` Lars Ingebrigtsen
2021-02-22 21:52 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-22 21:58 ` Lars Ingebrigtsen
2021-02-22 22:08 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-23 3:28 ` Eli Zaretskii
2021-02-23 7:09 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-23 15:31 ` Eli Zaretskii
2021-02-24 16:09 ` Lars Ingebrigtsen
2021-02-24 16:29 ` Peter Dean via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-02-24 16:38 ` Eli Zaretskii
2021-02-24 16:59 ` Lars Ingebrigtsen
2021-02-24 17:05 ` Eli Zaretskii
2021-02-25 15:15 ` Lars Ingebrigtsen [this message]
2021-02-25 15:29 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87tuq041s8.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=46702@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=laszlomail@protonmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.