From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#31574: 27.0; Doc string for `with-help-window' Date: Thu, 24 May 2018 21:09:30 +0300 Message-ID: <83zi0p9b8l.fsf@gnu.org> References: <> <<83k1rtauc7.fsf@gnu.org>> <73e710f8-8373-46e5-913a-b3cba178a384@default> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1527185291 10155 195.159.176.226 (24 May 2018 18:08:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 24 May 2018 18:08:11 +0000 (UTC) Cc: 31574@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu May 24 20:08:07 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fLuel-0002XV-0Q for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2018 20:08:07 +0200 Original-Received: from localhost ([::1]:40132 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fLugq-0004eC-8I for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2018 14:10:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34383) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fLugg-0004cH-PO for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 14:10:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fLugc-0002lV-LH for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 14:10:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:38877) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fLugc-0002lP-IT for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 14:10:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fLugc-00061G-AQ for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 14:10:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 24 May 2018 18:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31574 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 31574-submit@debbugs.gnu.org id=B31574.152718537123083 (code B ref 31574); Thu, 24 May 2018 18:10:02 +0000 Original-Received: (at 31574) by debbugs.gnu.org; 24 May 2018 18:09:31 +0000 Original-Received: from localhost ([127.0.0.1]:46773 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fLug7-00060F-BA for submit@debbugs.gnu.org; Thu, 24 May 2018 14:09:31 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:43303) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fLug5-000601-Ep for 31574@debbugs.gnu.org; Thu, 24 May 2018 14:09:29 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fLufw-0002XC-B1 for 31574@debbugs.gnu.org; Thu, 24 May 2018 14:09:24 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:40248) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fLufw-0002X6-8l; Thu, 24 May 2018 14:09:20 -0400 Original-Received: from [176.228.60.248] (port=4151 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fLufv-0007zD-L6; Thu, 24 May 2018 14:09:20 -0400 In-reply-to: <73e710f8-8373-46e5-913a-b3cba178a384@default> (message from Drew Adams on Thu, 24 May 2018 10:17:49 -0700 (PDT)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:146491 Archived-At: > Date: Thu, 24 May 2018 10:17:49 -0700 (PDT) > From: Drew Adams > 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.