From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#31574: 27.0; Doc string for `with-help-window' Date: Thu, 24 May 2018 10:17:49 -0700 (PDT) Message-ID: <73e710f8-8373-46e5-913a-b3cba178a384@default> References: <> <<83k1rtauc7.fsf@gnu.org>> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1527182230 14598 195.159.176.226 (24 May 2018 17:17:10 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 24 May 2018 17:17:10 +0000 (UTC) Cc: 31574-done@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu May 24 19:17:06 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 1fLtrN-0003fD-GE for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2018 19:17:05 +0200 Original-Received: from localhost ([::1]:39915 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fLttU-0000t8-C8 for geb-bug-gnu-emacs@m.gmane.org; Thu, 24 May 2018 13:19:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49675) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fLttL-0000t1-UC for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 13:19:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fLttH-0002NM-0u for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 13:19:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:38834) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fLttG-0002NG-TM for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 13:19:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fLttF-0004pn-MD for bug-gnu-emacs@gnu.org; Thu, 24 May 2018 13:19:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 24 May 2018 17:19:01 +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-done@debbugs.gnu.org id=D31574.152718228318518 (code D ref 31574); Thu, 24 May 2018 17:19:01 +0000 Original-Received: (at 31574-done) by debbugs.gnu.org; 24 May 2018 17:18:03 +0000 Original-Received: from localhost ([127.0.0.1]:46731 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fLtsJ-0004ob-Cu for submit@debbugs.gnu.org; Thu, 24 May 2018 13:18:03 -0400 Original-Received: from userp2120.oracle.com ([156.151.31.85]:43364) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fLtsH-0004o7-6S for 31574-done@debbugs.gnu.org; Thu, 24 May 2018 13:18:01 -0400 Original-Received: from pps.filterd (userp2120.oracle.com [127.0.0.1]) by userp2120.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w4OHGJJb172146; Thu, 24 May 2018 17:17:54 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=6BMYsMeaZ+PSSHiPXpbk4wj34LKjCRvBUVLS5Gq3lNk=; b=F/V185fxevJl2362+XiziDEFNcUoX09cEo1OVD8tWoIBsszrHwB8j0KzepPOZL97tYsQ 7IgzL0tQBEDRZucYIHNC6rkIJkCtqSKSZS800BAQoRLm5T5+n2tecK+Sm0pd+7AB+FOb vsAkPE5DMsmkLfluLyCOzTcEE+ULBo26+V+mQs1GLc1Z28uvpCKWxzvzutebIJ4n7E5p H47RuSVF5Cz2nP2NeybtJA26tRHPZ/Kj39WN7OZzOBSoBz0la/KG9sU5jqRFUS3UqaH/ vkGl85aJC2VV0zjUJDUgnFNrJ7/mpDq3Ba1NYOcXXusWdWChmZnq3X5hSUMs3NJbysy4 wg== Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp2120.oracle.com with ESMTP id 2j4nh7sfw5-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 24 May 2018 17:17:53 +0000 Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id w4OHHqXU013181 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 24 May 2018 17:17:53 GMT Original-Received: from abhmp0002.oracle.com (abhmp0002.oracle.com [141.146.116.8]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id w4OHHpMn020648; Thu, 24 May 2018 17:17:51 GMT In-Reply-To: <<83k1rtauc7.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4690.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8902 signatures=668700 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=732 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1805240197 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:146490 Archived-At: > > 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": >=20 > "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?