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#38158: 26.3; Function usage in docstring not documented Date: Thu, 14 Nov 2019 11:51:44 +0200 Message-ID: <83sgmq7plb.fsf@gnu.org> References: <80h83c6p07.fsf@felesatra.moe> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="158794"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 38158@debbugs.gnu.org To: Allen Li Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Nov 14 11:04:17 2019 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 1iVBz6-000f9h-Q5 for geb-bug-gnu-emacs@m.gmane.org; Thu, 14 Nov 2019 11:04:16 +0100 Original-Received: from localhost ([::1]:55160 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVBz4-0000Oo-PD for geb-bug-gnu-emacs@m.gmane.org; Thu, 14 Nov 2019 05:04:14 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39011) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVBoF-0005VH-NK for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 04:53:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iVBoE-000064-Pc for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 04:53:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:52133) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iVBoE-00005g-61 for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 04:53:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iVBoE-00083o-12 for bug-gnu-emacs@gnu.org; Thu, 14 Nov 2019 04:53: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: Thu, 14 Nov 2019 09:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 38158 X-GNU-PR-Package: emacs Original-Received: via spool by 38158-submit@debbugs.gnu.org id=B38158.157372512830915 (code B ref 38158); Thu, 14 Nov 2019 09:53:01 +0000 Original-Received: (at 38158) by debbugs.gnu.org; 14 Nov 2019 09:52:08 +0000 Original-Received: from localhost ([127.0.0.1]:60954 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVBnM-00082Y-9a for submit@debbugs.gnu.org; Thu, 14 Nov 2019 04:52:08 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:57924) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVBnK-000828-Ic for 38158@debbugs.gnu.org; Thu, 14 Nov 2019 04:52:06 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:47259) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iVBnF-0007wb-8y; Thu, 14 Nov 2019 04:52:01 -0500 Original-Received: from [176.228.60.248] (port=4714 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1iVBnE-0001aj-N2; Thu, 14 Nov 2019 04:52:01 -0500 In-reply-to: (message from Allen Li on Sun, 10 Nov 2019 12:11:49 +0000) 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:171572 Archived-At: > From: Allen Li > Date: Sun, 10 Nov 2019 12:11:49 +0000 > > On Sun, Nov 10, 2019 at 9:48 AM Allen Li wrote: > > > > It is not documented in the Elisp info manual that a function docstring > > ending with: > > > > \(fn SOME ARGS) > > > > will have a custom usage displayed by `describe-function'. > > > > It seems useful to document this. > > Never mind, I found this documented under Function Documentation. I > somehow missed it the first time C-sing in the manual. Can you describe how you looked for this? Did you use the 'i' command in Info? It's possible that we need to improve the indexing.