From debbugs-submit-bounces@debbugs.gnu.org Sun Nov 10 04:48:33 2019 Received: (at submit) by debbugs.gnu.org; 10 Nov 2019 09:48:33 +0000 Received: from localhost ([127.0.0.1]:50618 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iTjpg-0000A0-9c for submit@debbugs.gnu.org; Sun, 10 Nov 2019 04:48:32 -0500 Received: from lists.gnu.org ([209.51.188.17]:35556) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iTjpe-00009t-L6 for submit@debbugs.gnu.org; Sun, 10 Nov 2019 04:48:30 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:52308) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iTjpd-0002uS-CJ for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:48:30 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED autolearn=disabled version=3.3.2 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iTjpc-0005Or-9o for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:48:29 -0500 Received: from mail-pg1-x534.google.com ([2607:f8b0:4864:20::534]:41876) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iTjpb-0005Oh-Ps for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:48:28 -0500 Received: by mail-pg1-x534.google.com with SMTP id h4so7107912pgv.8 for ; Sun, 10 Nov 2019 01:48:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=felesatra-moe.20150623.gappssmtp.com; s=20150623; h=from:to:subject:date:message-id:mime-version; bh=UYHpn9KCcMxS796i8dFdfFT2WZVBsndGrV+mOJ5mJ3w=; b=miqpcyj2NmRZtVE2Nbu5DHzQXV1kZN37X126I6HBQ8fZiBnvlSAbyeuOZZYmdWuS1F P8RoRB2giTHY98P8O28ZSOwk8t+U6ZN93Cb8CPXYUh+whKvQnF4LQON12YuqYG25bsbz qMjm2crmB7rpsAL7JGScfwlq4qq5keoQs0F1rWuVsKE3BtSxv4F3VhGchnq66lbPjW3x 3MZtkUp0LP42rGS2nHaKe4s6UOumjNjx0Dwu5sSoUOdJ8cC4S9V5tM2zQZr1duKDrozJ eqaRrL5Y6xvC5l2Lsdz66y2jsqLQBQqvC5gJ7ChOVNNWkz+S30R0Syp6OJtyFCeZhZRe GVig== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:mime-version; bh=UYHpn9KCcMxS796i8dFdfFT2WZVBsndGrV+mOJ5mJ3w=; b=h/FGxtBFuw8iU1XCQNo7F+TBchr2pWkEAx6T4ytC70Av3zKn/oVvLNuzYrBbT/BJ43 y/lojtEs2O+urSJinSRxF53X6VHRj++8LQhVtnphMiJWazK3LhoKBzMl9ry5K6SNGTbZ +3hqvkjSEqWoOCqFTY2OhOPQiRptzdP9Cf2QwKY9ml67QOlf+CI9tlOYHHn68MIYgMcH uZZUgdUcLXZrkPk/Bo9mBiAqM8eGYVT4Oar/sEZ7mKWhLGKIONIYsAQVrwik7titjL3x nbmhalyC6nUUUU4cxxpMoIKxK4B2Nbtj7PLn4vcy0fA8TYtLCTemXnHpwfJvmkWUhGCy uWag== X-Gm-Message-State: APjAAAV9+g6T4bJpxksldbiYFhLrjeGFDpAYsiCjsBgqT9zSTwumzStg CQLc93Q0MCNXlAWAHhPd6cSBT1LIivc= X-Google-Smtp-Source: APXvYqxKx7fMVcxiMV0f0bXAVH+8T7gl1BfvjgGMUeKGX6E8kpQsdZrAnhZQdvDUEyzbsk/trDNI3w== X-Received: by 2002:a63:4705:: with SMTP id u5mr1051449pga.7.1573379305716; Sun, 10 Nov 2019 01:48:25 -0800 (PST) Received: from localhost ([2600:1700:7270:7d1f:fa59:71ff:fe00:10cc]) by smtp.gmail.com with ESMTPSA id x192sm16391410pfd.96.2019.11.10.01.48.24 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 10 Nov 2019 01:48:25 -0800 (PST) From: Allen Li To: bug-gnu-emacs@gnu.org Subject: 26.3; Function usage in docstring not documented Date: Sun, 10 Nov 2019 01:48:24 -0800 Message-ID: <80h83c6p07.fsf@felesatra.moe> MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:4864:20::534 X-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) 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. 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 From debbugs-submit-bounces@debbugs.gnu.org Sun Nov 10 07:12:09 2019 Received: (at 38158-done) by debbugs.gnu.org; 10 Nov 2019 12:12:09 +0000 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 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 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) MIME-Version: 1.0 References: <80h83c6p07.fsf@felesatra.moe> In-Reply-To: <80h83c6p07.fsf@felesatra.moe> From: Allen Li Date: Sun, 10 Nov 2019 12:11:49 +0000 Message-ID: Subject: Re: 26.3; Function usage in docstring not documented To: 38158-done@debbugs.gnu.org Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.7 (/) X-Debbugs-Envelope-To: 38158-done X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.3 (/) 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 From debbugs-submit-bounces@debbugs.gnu.org Thu Nov 14 04:52:08 2019 Received: (at 38158) by debbugs.gnu.org; 14 Nov 2019 09:52:08 +0000 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 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 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 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 Date: Thu, 14 Nov 2019 11:51:44 +0200 Message-Id: <83sgmq7plb.fsf@gnu.org> From: Eli Zaretskii To: Allen Li In-reply-to: (message from Allen Li on Sun, 10 Nov 2019 12:11:49 +0000) Subject: Re: bug#38158: 26.3; Function usage in docstring not documented References: <80h83c6p07.fsf@felesatra.moe> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Spam-Score: -1.6 (-) X-Debbugs-Envelope-To: 38158 Cc: 38158@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.6 (--) > 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. From unknown Fri Jun 13 10:33:39 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Thu, 12 Dec 2019 12:24:10 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator