From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Allen Li Newsgroups: gmane.emacs.bugs Subject: bug#38158: 26.3; Function usage in docstring not documented Date: Sun, 10 Nov 2019 12:11:49 +0000 Message-ID: References: <80h83c6p07.fsf@felesatra.moe> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="90505"; mail-complaints-to="usenet@blaine.gmane.org" To: 38158-done@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 10 13:13:23 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 1iTm5q-000NOc-6i for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2019 13:13:22 +0100 Original-Received: from localhost ([::1]:42578 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iTm5o-0007Nr-Ja for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2019 07:13:20 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60639) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iTm5Y-0007LP-0j for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 07:13:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iTm5X-0002DR-2Z for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 07:13:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:41919) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iTm5W-0002DF-QP for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 07:13:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iTm5W-00042X-K7 for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 07:13:02 -0500 Resent-From: Allen Li Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sun, 10 Nov 2019 12:13:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 38158 X-GNU-PR-Package: emacs Mail-Followup-To: 38158@debbugs.gnu.org, darkfeline@felesatra.moe, darkfeline@felesatra.moe Original-Received: via spool by 38158-done@debbugs.gnu.org id=D38158.157338792915459 (code D ref 38158); Sun, 10 Nov 2019 12:13:02 +0000 Original-Received: (at 38158-done) by debbugs.gnu.org; 10 Nov 2019 12:12:09 +0000 Original-Received: from localhost ([127.0.0.1]:50738 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iTm4e-00041H-Qf for submit@debbugs.gnu.org; Sun, 10 Nov 2019 07:12:09 -0500 Original-Received: from mail-qk1-f180.google.com ([209.85.222.180]:33852) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iTm4c-00040m-BX for 38158-done@debbugs.gnu.org; Sun, 10 Nov 2019 07:12:06 -0500 Original-Received: by mail-qk1-f180.google.com with SMTP id 205so8980540qkk.1 for <38158-done@debbugs.gnu.org>; Sun, 10 Nov 2019 04:12:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=felesatra-moe.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to; bh=LzTwP2Lr+S+J4Varepcybrd6Jq5uRk9BF8jBfsvycHw=; b=H2VroW9HxZlzmYzSmufr4W28mY8nh0YKCzSUrl2s1RWOYq9lwUBJ8jkeGRR3dV8uXk Pkpxt317K+v+0dOZxIQITXhfLHwP28FahwONIluGhFa9YGDMWciRU8AyE1rQmjEVv8B/ pNV75Lb7mNNL4R1eYfmToSLqAygM8wN17NYAzRx4RMYd9qk7AxKlT0NpN3ZEFPfloP2p V08EHxt5uPFWwUnTHlAmdZip9X1U/JinOXtcUVauSn669h+MOW/R22TkTPcUIFZMvXCg ZFjGVz/6S6Jv602CWep4C1H01E03oKamLpaR1CDMZldVooW8JobfxFE/1MllriUP1NFj KGQQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=LzTwP2Lr+S+J4Varepcybrd6Jq5uRk9BF8jBfsvycHw=; b=q6KehqdGG7J3bYNgDxQuJCVySSt9U9ml24s+2kH+a5r8HkfC53+QHL1SIF1Y6jrNcT 8cjBQ7NqmgPqrzl97xTlwRDCxcUA3H2T8XXk9APR++oRF7fwB6AsbWjfdjBjWZ4jZsnE rb4EtUFTAeKa7S6sZX8zicVf3Bo5b0dmQnSpp+BLMCx+FzpeHCVLb7YW9hRUYNKwbLcf /A73EWhxEHjl99SNEQyt7oChcDHLK30GG4Uuj7eaQ7Q7twVYCS9dUM3wW7jLikgZ1Idt F7BDLB4N4khEGYTpWfXDOXbS2feDPNs88my5PHcRJRGElQ08Sludfh8xRAB9KFgC71BP 4c2g== X-Gm-Message-State: APjAAAWXhaxFx36vNEWnWm/Ba6B3p2Hh2XZ1XLLDBe6ScHWD37uh/jyJ /oiuc0rslrtYUudq2f41KaY0cdr3eDHNQVYqDhBQSTzL X-Google-Smtp-Source: APXvYqxyo7eVjrSdOlQZsMG2+o7rSucEzXsfANPVZbWCppJdt21yMhkVIYStk2bPF8vTOFyCRamQoRtubPaAuuChIu0= X-Received: by 2002:a37:ae05:: with SMTP id x5mr5823535qke.243.1573387920638; Sun, 10 Nov 2019 04:12:00 -0800 (PST) In-Reply-To: <80h83c6p07.fsf@felesatra.moe> 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:171379 Archived-At: 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. > > In GNU Emacs 26.3 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.10) > of 2019-08-29 built on juergen > Windowing system distributor 'The X.Org Foundation', version 11.0.12005000 > System Description: Arch Linux