From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#39295: 26.3; kbd-help property is undocumented Date: Fri, 31 Jan 2020 19:10:47 +0200 Message-ID: <83wo97k0vc.fsf@gnu.org> References: <3E9F2FF0-FCD7-4406-8AFE-4A5F7C79353D@gmail.com> <83a763lo2o.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="5433"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 39295@debbugs.gnu.org To: Howard Melman Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jan 31 18:12:26 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ixZqD-0001Mo-IM for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 31 Jan 2020 18:12:25 +0100 Original-Received: from localhost ([::1]:56750 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ixZqC-0002i1-Iq for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 31 Jan 2020 12:12:24 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58899) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ixZpr-0002fM-N2 for bug-gnu-emacs@gnu.org; Fri, 31 Jan 2020 12:12:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ixZpq-0005Go-RD for bug-gnu-emacs@gnu.org; Fri, 31 Jan 2020 12:12:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:60252) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ixZpq-0005Fs-NC for bug-gnu-emacs@gnu.org; Fri, 31 Jan 2020 12:12:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ixZpq-0006La-GV for bug-gnu-emacs@gnu.org; Fri, 31 Jan 2020 12:12:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 31 Jan 2020 17:12:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 39295 X-GNU-PR-Package: emacs Original-Received: via spool by 39295-submit@debbugs.gnu.org id=B39295.158049068424354 (code B ref 39295); Fri, 31 Jan 2020 17:12:02 +0000 Original-Received: (at 39295) by debbugs.gnu.org; 31 Jan 2020 17:11:24 +0000 Original-Received: from localhost ([127.0.0.1]:37992 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ixZpE-0006Kj-Bp for submit@debbugs.gnu.org; Fri, 31 Jan 2020 12:11:24 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:49564) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ixZpC-0006KX-DM for 39295@debbugs.gnu.org; Fri, 31 Jan 2020 12:11:22 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49298) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ixZp4-0002Ve-PQ; Fri, 31 Jan 2020 12:11:15 -0500 Original-Received: from [176.228.60.248] (port=4389 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1ixZow-0008JM-HW; Fri, 31 Jan 2020 12:11:12 -0500 In-reply-to: (message from Howard Melman on Fri, 31 Jan 2020 11:10:26 -0500) 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: 209.51.188.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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:175513 Archived-At: > From: Howard Melman > Date: Fri, 31 Jan 2020 11:10:26 -0500 [Please keep the bug address on the CC list.] > > It indeed is unused, so I'm not sure it should be documented at this > > time. As for "new": the help-at-pt.el file was added to Emacs 17 > > years ago, and its original version already included support for this > > property. > > Perhaps it should be deprecated? Without documentation it's unlikely to be used. It is documented in the doc strings, isn't it? > It would be nice if some place described it as unused (and perhaps as unused for a very long time). Unused in Emacs itself doesn't mean no one out there uses it. A feature that is unused doesn't do any harm. > Since the code will use it, it should remain in the docstring. If you don't want to add it to the manual then may I suggest at a least a comment in the code saying so and what its intent was, perhaps in the package commentary, would be useful. Not every feature is documented in the manual, only the important ones are. And I'm not sure I see the utility of stating in comments that we don't document this in the manual: we don't say that about all the other features not mentioned in the manual.