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 01:48:24 -0800 Message-ID: <80h83c6p07.fsf@felesatra.moe> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="47139"; mail-complaints-to="usenet@blaine.gmane.org" To: 38158@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 10 10:49:13 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 1iTjqK-000C6x-Be for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2019 10:49:12 +0100 Original-Received: from localhost ([::1]:42218 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iTjqJ-00034E-1d for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2019 04:49:11 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52348) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iTjqB-00033Y-NY for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:49:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iTjqA-0005kH-BX for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:49:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:41797) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iTjqA-0005kD-84 for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:49:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iTjqA-0000Ay-4P for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2019 04:49:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Allen Li Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 10 Nov 2019 09:49:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 38158 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.1573379313630 (code B ref -1); Sun, 10 Nov 2019 09:49:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 10 Nov 2019 09:48:33 +0000 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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) Original-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) X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. 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:171375 Archived-At: 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