all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 31574@debbugs.gnu.org
Subject: bug#31574: 27.0; Doc string for `with-help-window'
Date: Thu, 24 May 2018 21:09:30 +0300	[thread overview]
Message-ID: <83zi0p9b8l.fsf@gnu.org> (raw)
In-Reply-To: <73e710f8-8373-46e5-913a-b3cba178a384@default> (message from Drew Adams on Thu, 24 May 2018 10:17:49 -0700 (PDT))

> Date: Thu, 24 May 2018 10:17:49 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 31574-done@debbugs.gnu.org
> 
> > "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.

I told yesterday in response to another message of yours how can you
see the changes in the repository using  Web browser.  Please take a
look, then we can discuss the fix.

> The real problem is that after you follow the link there
> is NOTHING about `with-help-window', AFAICT.

No, the real problem is that the reference to help-window-setup gave
you wrong expectations regarding what information that function should
add.  My change tried to make those expectations match the original
intent.

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

That's a subroutine, so I don't necessarily see its doc string as
something we need to invest an effort in.





  reply	other threads:[~2018-05-24 18:09 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   ` bug#31574: 27.0; Doc string for `with-help-window' Drew Adams
2018-05-24 18:09     ` Eli Zaretskii [this message]
     [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

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

  git send-email \
    --in-reply-to=83zi0p9b8l.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=31574@debbugs.gnu.org \
    --cc=drew.adams@oracle.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.