From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: 31574-done@debbugs.gnu.org
Subject: bug#31574: 27.0; Doc string for `with-help-window'
Date: Thu, 24 May 2018 10:17:49 -0700 (PDT) [thread overview]
Message-ID: <73e710f8-8373-46e5-913a-b3cba178a384@default> (raw)
In-Reply-To: <<83k1rtauc7.fsf@gnu.org>>
> > The doc string ends with this sentence:
> >
> > See 'help-window-setup' for more options.
> >
> > But that link takes you to this text, which tells you nothing at all
> > about "more options":
>
> "Options" was not the best word here, so I rephrased the last sentence
> of the doc string.
I see that the bug was closed. Not sure what the fix was,
but if it was just to change "options" then it might not
really be fixed.
The real problem is that after you follow the link there
is NOTHING about `with-help-window', AFAICT.
And I should have been clear that the doc string of
`help-window-setup' is even more problematic. It doesn't
say anything helpful at all, AFAICT. What does setting
up that window even mean? The only thing this doc string
tells you, that you might not guess, is that VALUE is
returned from the function.
Did you fix the doc string of `help-window-setup', or can
you please do so as part of this bug? Or do you need a
separate bug filed for that?
next parent reply other threads:[~2018-05-24 17:17 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <<eb176951-ffc9-4303-893f-9c146782136d@default>
[not found] ` <<83k1rtauc7.fsf@gnu.org>
2018-05-24 17:17 ` Drew Adams [this message]
2018-05-24 18:09 ` bug#31574: 27.0; Doc string for `with-help-window' Eli Zaretskii
[not found] <<<eb176951-ffc9-4303-893f-9c146782136d@default>
[not found] ` <<<83k1rtauc7.fsf@gnu.org>
[not found] ` <<73e710f8-8373-46e5-913a-b3cba178a384@default>
[not found] ` <<83zi0p9b8l.fsf@gnu.org>
2018-05-24 18:26 ` Drew Adams
2018-05-24 19:09 ` Eli Zaretskii
2018-05-24 19:26 ` Drew Adams
2018-05-23 19:45 Drew Adams
2018-05-24 7:20 ` martin rudalics
2018-05-24 16:31 ` 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
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=73e710f8-8373-46e5-913a-b3cba178a384@default \
--to=drew.adams@oracle.com \
--cc=31574-done@debbugs.gnu.org \
--cc=eliz@gnu.org \
/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).