unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: laszlomail@protonmail.com, 46702@debbugs.gnu.org
Subject: bug#46702: Link symbol name in Help
Date: Thu, 25 Feb 2021 17:29:38 +0200	[thread overview]
Message-ID: <83eeh4rwrh.fsf@gnu.org> (raw)
In-Reply-To: <87tuq041s8.fsf@gnus.org> (message from Lars Ingebrigtsen on Thu,  25 Feb 2021 16:15:03 +0100)

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: laszlomail@protonmail.com,  46702@debbugs.gnu.org
> Date: Thu, 25 Feb 2021 16:15:03 +0100
> 
> > 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.

I didn't say we should reinstate that line, did I?

> 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.

Which is why I said we may wish rewriting it (and others like it, of
which we have quite a few, I think).





      reply	other threads:[~2021-02-25 15:29 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
2021-02-25 15:29                           ` Eli Zaretskii [this message]

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83eeh4rwrh.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=46702@debbugs.gnu.org \
    --cc=larsi@gnus.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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).