From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Damien Cassou Newsgroups: gmane.emacs.bugs Subject: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command Date: Tue, 17 Apr 2018 14:44:17 +0200 Message-ID: <87k1t6j93y.fsf@cassou.me> References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1523968997 31460 195.159.176.226 (17 Apr 2018 12:43:17 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 17 Apr 2018 12:43:17 +0000 (UTC) Cc: 31191@debbugs.gnu.org To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Apr 17 14:43:13 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Pwz-000813-Vh for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 14:43:10 +0200 Original-Received: from localhost ([::1]:36587 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8Pz6-00060o-KT for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 08:45:20 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52133) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8Pyu-0005zG-VL for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 08:45:15 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8Pyp-0000sA-4B for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 08:45:09 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48932) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f8Pyo-0000ry-T0 for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 08:45:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f8Pyo-00070t-Jr for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 08:45:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 17 Apr 2018 12:45:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31191 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 31191-submit@debbugs.gnu.org id=B31191.152396906526901 (code B ref 31191); Tue, 17 Apr 2018 12:45:02 +0000 Original-Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 12:44:25 +0000 Original-Received: from localhost ([127.0.0.1]:56829 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8PyB-0006zn-ON for submit@debbugs.gnu.org; Tue, 17 Apr 2018 08:44:25 -0400 Original-Received: from mail.choca.pics ([62.210.108.126]:53020) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Py9-0006zY-HX for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 08:44:22 -0400 Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 59EE723240ED; Tue, 17 Apr 2018 14:44:20 +0200 (CEST) Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id L1RprWW8xEsr; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 45B4A23240F6; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics 45B4A23240F6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1523969059; bh=HnLdK8VTQ+J3pDWPg6xfSnQ35nFVlZezKjJwimiFskQ=; h=From:To:Date:Message-ID:MIME-Version; b=bvrzZYEmkVFwZfJp0L+Pb11FOpRqWkCvKVkYo6biUxHsIyVExWAO9ZQx/ttFCnHgl qWxTOYM/ACv/kSGzvTrVVW194JKaLiz2VAAZ3/7kK2XwMAYDB8ioLvJCfhQz9rMbkJ ietZgHWvQU8Sg51kt6VkRXP4qjSoxmOX8u3BYlwKKs6o71MbF7l2Fpj+51S97rT8uj 8N0ZtTCAgDreN3D7SXz191livNhhewKP4kzoAhlEmZMDbD0zTLUyucvr0yp74SygmL J3+j2lfRG+8zMnQgZUQm+/2IIks9ot5aDTH1CQxNd8Phm8E8eEHCmHTJXZvfJFcxDc zxiIqIw56g/9w== X-Virus-Scanned: amavisd-new at choca.pics Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id 1-io1loBDiPh; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) Original-Received: from luz4 (unknown [IPv6:2a00:5884:8368:0:981a:1b8d:5415:a323]) by mail.choca.pics (Postfix) with ESMTPSA id E771723240ED; Tue, 17 Apr 2018 14:44:18 +0200 (CEST) In-Reply-To: <87y3hmt5x5.fsf@gmail.com> 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: 208.118.235.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:145483 Archived-At: Noam Postavsky writes: >> +\(fn NAME BUFFER COMMAND)" >> (declare (advertised-calling-convention (name buffer command) "23.1")) > > I think this is redundant since advertised-calling-convention already > does the same. you are right, thank you. I didn't know about that and helpful does not take it into account (I've just reported the issue). What is the preferred way to advertise a signature, the declare form or a last line in the docstring? If you answer the question, I can fix the manual to add links between (info "(elisp) Declare Form") and (info "(elisp) Function Documentation"). -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill