From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#38996: 26.3; Missing documentation for `list-at-point' function in elisp manual. Date: Tue, 07 Jan 2020 18:18:02 +0200 Message-ID: <83imlnckat.fsf@gnu.org> References: <258277221.7485058.1578342795150.ref@mail.yahoo.com> <258277221.7485058.1578342795150@mail.yahoo.com> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="149378"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 38996@debbugs.gnu.org To: Mark Harig Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jan 07 17:18:15 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iorYZ-000Zao-5U for geb-bug-gnu-emacs@m.gmane.org; Tue, 07 Jan 2020 17:18:11 +0100 Original-Received: from localhost ([::1]:52436 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iorYX-0003l3-I6 for geb-bug-gnu-emacs@m.gmane.org; Tue, 07 Jan 2020 11:18:09 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39989) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iorYR-0003dS-Ep for bug-gnu-emacs@gnu.org; Tue, 07 Jan 2020 11:18:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iorYQ-0006Tr-DT for bug-gnu-emacs@gnu.org; Tue, 07 Jan 2020 11:18:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:43123) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iorYQ-0006Tn-Ag for bug-gnu-emacs@gnu.org; Tue, 07 Jan 2020 11:18:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iorYQ-0002fC-7N for bug-gnu-emacs@gnu.org; Tue, 07 Jan 2020 11:18: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: Tue, 07 Jan 2020 16:18:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 38996 X-GNU-PR-Package: emacs Original-Received: via spool by 38996-submit@debbugs.gnu.org id=B38996.157841387710227 (code B ref 38996); Tue, 07 Jan 2020 16:18:02 +0000 Original-Received: (at 38996) by debbugs.gnu.org; 7 Jan 2020 16:17:57 +0000 Original-Received: from localhost ([127.0.0.1]:49096 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iorYL-0002et-8h for submit@debbugs.gnu.org; Tue, 07 Jan 2020 11:17:57 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:59063) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iorYJ-0002eg-UD for 38996@debbugs.gnu.org; Tue, 07 Jan 2020 11:17:56 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49394) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iorYE-0006Oe-RO; Tue, 07 Jan 2020 11:17:50 -0500 Original-Received: from [176.228.60.248] (port=2270 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1iorYD-00061n-V1; Tue, 07 Jan 2020 11:17:50 -0500 In-reply-to: <258277221.7485058.1578342795150@mail.yahoo.com> (bug-gnu-emacs@gnu.org) 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:174313 Archived-At: > Date: Mon, 6 Jan 2020 20:33:15 +0000 (UTC) > From: Mark Harig via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > The NEWS file for Emacs 26.2/.3 documents changes to `thing-at-point', including mention of the function > `list-at-point'. C-h f (describe-function) provides documentation of `list-at-point', but C-h S > (info-lookup-symbol) for `list-at-point' responds with "Not documented as a symbol: list-at-point'. A check of > the node in the elisp manual that documents `thing-at-point' does not show any mention of `list-at-point', nor > does the previous node ("Near Point"). If `list-at-point' is documented elsewhere in the elisp manual, then an > index manual entry is needed for this function. Without this documentation, it is still possible to use > `list-at-point', but when it is not documented in the manual, users might not know that it exists. Thank you for your report. We don't document every function in the manual: that would make the manual too large (it already prints as 2 very thick volumes). This function is new, and has no callers inside Emacs, so whether it is important enough to warrant a place in the manual remains to be seen. For discoverability, we rely on built-in Help features such as 'apropos', and yes, on people reading NEWS when they start using a new version, because reading that will tell them about changes in a much more efficient way than the same information buried among many hundreds of pages of the manual. So I think we should wait and see if this function needs to be added to the manual.