From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Noam Postavsky Newsgroups: gmane.emacs.bugs Subject: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command Date: Tue, 17 Apr 2018 09:06:23 -0400 Message-ID: <87vacqt228.fsf@gmail.com> References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> <87k1t6j93y.fsf@cassou.me> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1523970309 25654 195.159.176.226 (17 Apr 2018 13:05:09 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 17 Apr 2018 13:05:09 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) Cc: 31191@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Apr 17 15:05:05 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 1f8QID-0006ZW-Df for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 15:05:05 +0200 Original-Received: from localhost ([::1]:37710 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8QKK-0000hY-2S for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 09:07:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35121) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8QKC-0000gt-Tt for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 09:07:09 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8QK6-0003uV-Pe for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 09:07:08 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48968) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f8QK6-0003uF-Lz for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 09:07:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f8QK6-0007Yr-Ak for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 09:07:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Noam Postavsky Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 17 Apr 2018 13:07: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.152397039529032 (code B ref 31191); Tue, 17 Apr 2018 13:07:02 +0000 Original-Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 13:06:35 +0000 Original-Received: from localhost ([127.0.0.1]:56865 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QJe-0007YC-NJ for submit@debbugs.gnu.org; Tue, 17 Apr 2018 09:06:34 -0400 Original-Received: from mail-io0-f172.google.com ([209.85.223.172]:42556) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QJd-0007Xv-26 for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 09:06:33 -0400 Original-Received: by mail-io0-f172.google.com with SMTP id d5so22249131iob.9 for <31191@debbugs.gnu.org>; Tue, 17 Apr 2018 06:06:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=4W81yFK5FIOezWyyUcxxw6v61q9gWVuyEqpb8S7l+SU=; b=UNmMWsoh2akAV5tB+fcSYy5c9rgh4PYXOJPbebKMQQW2kOSTvr/CZTVWevoh5wPNpI bd/Ckb9LSWGb/yEcQjTp5GGUgs9D48mQMnYJaEdvlXXKOnk6gSDgCxZ3apXLhh9GNE8x laMQkqjGyxV75tm0hr79i0moxbhZUNZ9aBSRrftFAy//IKKRU0eo5YZZOVVdCIfWWzuo Y0kG5znGVzmzvy7saVA4H5WVMtMI+ZGjOT2N5vsfBJ+SQh0kt6J9yyWcpcS3X5T4izLY He6WXxF2X12V3GkES1kHMFOBDLgD93gkJlevXkXROOw+Q0FdVCAbEZxqq144dbC6RRGm eeYQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=4W81yFK5FIOezWyyUcxxw6v61q9gWVuyEqpb8S7l+SU=; b=dJa1ajKzy4ltnfpvHRdHgo1MqbmNXp0TxfwPozjqEZsaM3Fg+hpPgIN/4d8AJICSpT lssONb/QrXF0vQOpSr9ACPjRVcuOQM6bp1s3vwBfRSGOwNcjkLMBbgQv44bPgr7nhPRF oaEllkZi+bPCC+95saih/ZqxwvX4Mc+Kso77+DYZRKHYOMt+oKLsxV8/dM4nLQlHMtyd JrBR6Ugd4+BICm8KLhWofMn9i2NEDZ5IzphU76VI9yhvU5p+M7MBw7NpSgtKaFWR7fkr VntfXTT+R4/feHZRoJS/2bdVOSeUQIBPJPHwmUMmooVoqoaCzp0Z07VD0V4R/AO/evmT XzWg== X-Gm-Message-State: ALQs6tDDMiJI7DrlWwqB578Ts4Vef7UfPbHf26pwkaWmC4Pk3DeanzsZ O/qqJEZEY70ODqCKBxvUUZbXxQ== X-Google-Smtp-Source: AIpwx4+4e4VReeyly+1OWFMDaGovM8zP8bjuPhxkpOiSgMci7F0bA4UboLEvjV9FvbTsX56/a1tsoQ== X-Received: by 10.107.101.7 with SMTP id z7mr1776224iob.198.1523970384945; Tue, 17 Apr 2018 06:06:24 -0700 (PDT) Original-Received: from zebian (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34]) by smtp.googlemail.com with ESMTPSA id x5sm7187403iod.5.2018.04.17.06.06.24 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 17 Apr 2018 06:06:24 -0700 (PDT) In-Reply-To: <87k1t6j93y.fsf@cassou.me> (Damien Cassou's message of "Tue, 17 Apr 2018 14:44:17 +0200") 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:145488 Archived-At: Damien Cassou writes: > 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"). The advertised-calling-convention declaration should be used when you want the old way of calling to trigger a warning during byte compilation. Otherwise, the docstring method should be used.