From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Artur Malabarba Newsgroups: gmane.emacs.bugs Subject: bug#22462: 25.0.50; Docstring of cl-defun/defmacro are too short Date: Tue, 05 Jul 2016 23:06:40 +0000 Message-ID: References: <87d1sqqcbi.fsf@gmail.com> <8760yhdior.fsf@mbork.pl> <87a8i0hel5.fsf@users.sourceforge.net> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=001a1145037e03e2760536eb8237 X-Trace: ger.gmane.org 1467760046 19217 80.91.229.3 (5 Jul 2016 23:07:26 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 5 Jul 2016 23:07:26 +0000 (UTC) Cc: 22462@debbugs.gnu.org To: npostavs@users.sourceforge.net, Marcin Borkowski Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jul 06 01:07:17 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1bKZQw-0005Ci-VI for geb-bug-gnu-emacs@m.gmane.org; Wed, 06 Jul 2016 01:07:15 +0200 Original-Received: from localhost ([::1]:58511 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKZQw-0005RP-7w for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Jul 2016 19:07:14 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34353) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKZQp-0005R7-E4 for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2016 19:07:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bKZQk-0001Z8-Iq for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2016 19:07:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:54600) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKZQk-0001Z1-FF for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2016 19:07:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1bKZQk-0002bT-7H for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2016 19:07:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Artur Malabarba Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 05 Jul 2016 23:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 22462 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 22462-submit@debbugs.gnu.org id=B22462.14677600179996 (code B ref 22462); Tue, 05 Jul 2016 23:07:02 +0000 Original-Received: (at 22462) by debbugs.gnu.org; 5 Jul 2016 23:06:57 +0000 Original-Received: from localhost ([127.0.0.1]:38704 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bKZQe-0002b9-Et for submit@debbugs.gnu.org; Tue, 05 Jul 2016 19:06:56 -0400 Original-Received: from mail-vk0-f54.google.com ([209.85.213.54]:34506) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bKZQd-0002ax-Dy for 22462@debbugs.gnu.org; Tue, 05 Jul 2016 19:06:56 -0400 Original-Received: by mail-vk0-f54.google.com with SMTP id t66so909453vka.1 for <22462@debbugs.gnu.org>; Tue, 05 Jul 2016 16:06:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=02SMwp21Q97FTw5V/biPccWqabbeVTahMqFBYtSAK2c=; b=GWKJpxQlbeoxSFqLQHSbddIeaAJaw76fV3+JNm82eXjQWfzbxzp0CQWOiHdPbC/Ir/ BLRJBjvAIv6dEl7hYH52NE5zpO99bDhnDpL2dMDI01RlKlRd9RAs+F7EoHSc/7WuGyrH biwK0IC593OlY9kuBi9XFmbIwUdMfU0qhorWS0niq3wsEMCIy7cokON7nmYhNoJHqXi4 fu4m75/nu1mC4zN8M88bgAT645PQNYFneTIckJP6dmOvDUsiAShiFNJORUtc94BjBYvs b1dbE1f8+hgb4+A3PW1TReKHNC/t/USyaiX9vdwi1TOPYyaJ3qSCuzknxzcMAzo9jjln y82Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=02SMwp21Q97FTw5V/biPccWqabbeVTahMqFBYtSAK2c=; b=aemuu6ckyNW8KucNcing6UpA3AomgH2CO1Y2PZqJfvbhr6bwf6xFTfVvamiwvIZGND BBWrAOZUeyQySv+StzuWWLVPwD4LH8qt1n+PayM9wHeWjA1RMUgS89mCHJZXajuso4tx k6k37OIQ6WBClbmdXlMcwoCU4rJG+59okMmHigzWzqHI+D14YeW1euxr8WhQgi+OnQUW a/gVKz4V0EBOJusbUmj2dqvbTzChHkEaiIiRWSCYSWlMQmfARg+2rP1bHgCKtRtV+RKl 9kT4xJUBBZPQYYVQeqTj2K1gT3BVzuvJefLO8VTFU8Kk8A5Q0MHe0wrP0OMOFWDabUbL Ny8w== X-Gm-Message-State: ALyK8tInxpguQNApePJY4pJ2VygF50tXrQGPCxzpaZBQ24QSQBYi7hL4LlJpj9/cKa0ZCBE43yV+ID2HXitPBQ== X-Received: by 10.31.129.203 with SMTP id c194mr7234062vkd.26.1467760010057; Tue, 05 Jul 2016 16:06:50 -0700 (PDT) In-Reply-To: <87a8i0hel5.fsf@users.sourceforge.net> 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:120473 Archived-At: --001a1145037e03e2760536eb8237 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Looks fine to me! On Sat, Jul 2, 2016 at 1:02 AM wrote: > tags 22462 patch > quit > > Marcin Borkowski writes: > > > On 2016-01-25, at 09:43, Artur Malabarba > wrote: > > > >> Every time I turn to cl-defun or cl-defmacro (usually for the extra > >> arglist versatility), I end up asking myself =E2=80=9Cwas it &key or &= keys?=E2=80=9D or > >> =E2=80=9Cwhat was the name of that really long option?=E2=80=9D. > >> > >> Naturally, I turn to `C-h f cl-defun', only to be told that it works > >> =E2=80=9CLike normal =E2=80=98defun=E2=80=99, except ARGLIST allows fu= ll Common Lisp > >> conventions=E2=80=9D. That's not very helpful for someone who's not pr= officient > >> in Common Lisp. > >> > >> I think there should be a link to the relevant info node and, > preferably, > >> a brief summary of the conventions. > > > > +1. And I'd vote for a summary, not a link. > > Here's a patch adding both a terse summary and a link, does it look ok? > > --001a1145037e03e2760536eb8237 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
Looks fine to me!

On Sat, Jul 2, 2016 at 1:02 AM <npostavs@users.sourceforge.net> wrote:
tags 22462 patch
quit

Marcin Borkowski <mb= ork@mbork.pl> writes:

> On 2016-01-25, at 09:43, Artur Malabarba <bruce.connor.am@gmail.com> wro= te:
>
>> Every time I turn to cl-defun or cl-defmacro (usually for the extr= a
>> arglist versatility), I end up asking myself =E2=80=9Cwas it &= key or &keys?=E2=80=9D or
>> =E2=80=9Cwhat was the name of that really long option?=E2=80=9D. >>
>> Naturally, I turn to `C-h f cl-defun', only to be told that it= works
>> =E2=80=9CLike normal =E2=80=98defun=E2=80=99, except ARGLIST allow= s full Common Lisp
>> conventions=E2=80=9D. That's not very helpful for someone who&= #39;s not profficient
>> in Common Lisp.
>>
>> I think there should be a link to the relevant info node and, pref= erably,
>> a brief summary of the conventions.
>
> +1.=C2=A0 And I'd vote for a summary, not a link.

Here's a patch adding both a terse summary and a link, does it look ok?=

--001a1145037e03e2760536eb8237--