unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, 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 11:26:22 -0700 (PDT)	[thread overview]
Message-ID: <fbfa86da-6327-404d-bd9f-e2da1a4cb340@default> (raw)
In-Reply-To: <<83zi0p9b8l.fsf@gnu.org>>

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

I looked at your mention of this, which was apparently in a bug
#31311 message.  After jumping through some hoops, yes, one can
see the texinfo source code.

But even trying that for this bug, I don't see it.  I don't see
anything about 31574 here, which is presumably the latest and
right place to look for it (?):

http://git.savannah.gnu.org/cgit/emacs.git/log/

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

Which was what?

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

We disagree.  A doc string that says only that WINDOW is the
windo for displaying the help buffer (obvious), plus just
"Return VALUE" might as well not even exist (and the optional
arg should be called RETURN-VALUE).

This is a non-trivial function.  Some explanation of what the
window "setup" entails is appropriate.





       reply	other threads:[~2018-05-24 18:26 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>
     [not found]   ` <<73e710f8-8373-46e5-913a-b3cba178a384@default>
     [not found]     ` <<83zi0p9b8l.fsf@gnu.org>
2018-05-24 18:26       ` Drew Adams [this message]
2018-05-24 19:09         ` bug#31574: 27.0; Doc string for `with-help-window' Eli Zaretskii
2018-05-24 19:26           ` Drew Adams
     [not found] <<eb176951-ffc9-4303-893f-9c146782136d@default>
     [not found] ` <<83k1rtauc7.fsf@gnu.org>
2018-05-24 17:17   ` Drew Adams
2018-05-24 18:09     ` Eli Zaretskii
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=fbfa86da-6327-404d-bd9f-e2da1a4cb340@default \
    --to=drew.adams@oracle.com \
    --cc=31574@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).