GNU logs - #29786, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#29786: 27.0.50; About the argument list of methods
Resent-From: Michael Heerdegen <michael_heerdegen@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 20 Dec 2017 12:39:02 +0000
Resent-Message-ID: <handler.29786.B.151377353516014 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 29786 <at> debbugs.gnu.org
From: Michael Heerdegen <michael_heerdegen@HIDDEN>
Date: Wed, 20 Dec 2017 13:38:39 +0100
Message-ID: <87d139a81c.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Hello,

(1) In (info "(elisp) Generic Functions"), there is this paragraph:

 -- Macro: cl-defmethod name [qualifier] arguments &rest [docstring]
          body
     [...]
     The ARGUMENTS list, which must be identical in all the methods that
     implement a generic function, and must match the argument list of
     that function, provides argument specializers of the form =E2=80=98(ARG
     SPEC)=E2=80=99, where ARG is the argument name as specified in the
     =E2=80=98cl-defgeneric=E2=80=99 call, and SPEC is one of the following=
 specializer
     forms: [...]

It's not clear to me what the sentence saying the argument lists must
all be identical tries to say.  Surely they can't all be identical when
they need to specify different specializers?  Is there anything to say
at all, apart from the necessity to match the argument list of the
generic function mentioned in the next sentence?  Do I have to use the
same argument names as specified in the generic method?  That would be
suboptimal for my use case:

(2)  I want to implement a method of `seq-mapn' (see seq.el) for
streams.  It would be good if the following worked as expected:

#+begin_src emacs-lisp
(cl-defmethod seq-mapn (function (stream stream) &rest streams)
  "Map FUNCTION over the STREAMS.

Example: this prints the first ten Fibonacci numbers:

  (letrec ((fibs (stream-cons
                  1
                  (stream-cons
                   1
                   (seq-mapn #'+ fibs (stream-rest fibs))))))
    (seq-do #'print (seq-take fibs 10)))

\(fn FUNCTION STREAMS...)"
  (if (not (seq-every-p #'streamp streams))
      (cl-call-next-method)
    (cl-labels ((helper (f streams)
                        (stream-make
                         (unless (seq-some #'stream-empty-p streams)
                           (cons (apply f (mapcar #'stream-first streams))
                                 (helper f (mapcar #'stream-rest streams)))=
))))
      (helper function (cons stream streams)))))
#+end_src

Then C-h f seq-mapn prints the argument list of that method as

  (arg2 (arg3 stream) &rest rest)

Debugging suggested that "STREAMS..." is treated as a symbol name by the
code and rejected because it contains dots.

But even when I replace the signature specifying line at the end of the
docstring with "\(fn FUNCTION &rest STREAMS)", I get

  (arg0 (arg1 stream) &rest streams)

instead of what I have specified.  This only happens if I load the
byte-compiled code, however.

I think the documentation tries to say that I have to use exactly the
same argument names as in the generic method:

#+begin_src emacs-lisp
(cl-defmethod seq-mapn (function (sequence stream) &rest sequences)
  "Map FUNCTION over the STREAMS.

Example: this prints the first ten Fibonacci numbers:

  (letrec ((fibs (stream-cons
                  1
                  (stream-cons
                   1
                   (seq-mapn #'+ fibs (stream-rest fibs))))))
    (seq-do #'print (seq-take fibs 10)))"
  (if (not (seq-every-p #'streamp sequences))
      (cl-call-next-method)
    (cl-labels ((helper (f streams)
                        (stream-make
                         (unless (seq-some #'stream-empty-p streams)
                           (cons (apply f (mapcar #'stream-first streams))
                                 (helper f (mapcar #'stream-rest streams)))=
))))
      (helper function (cons sequence sequences)))))
#+end_src

That gives me for C-h f:

Implementations:

(sequence (arg1 stream) &rest sequences) in `~/software/elpa/packages/strea=
m/stream.el'.

That's a total mess now: the first argument FUNCTION is called
"sequence", the second arg "arg1", and the third &rest argument
"sequences", which is not what I want because these must all be streams
(as tested in the method body), so this results in the most confusing
generated documentation of all.

TIA,

Michael.

In GNU Emacs 27.0.50 (build 24, x86_64-pc-linux-gnu, GTK+ Version 3.22.24)
 of 2017-12-14 built on drachen
Repository revision: 269fa5482d0761e612734b87982d7a708330bd37
Windowing system distributor 'The X.Org Foundation', version 11.0.11905000
System Description: Debian GNU/Linux testing (buster)

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Michael Heerdegen <michael_heerdegen@HIDDEN>
Subject: bug#29786: Acknowledgement (27.0.50; About the argument list of
 methods)
Message-ID: <handler.29786.B.151377353516014.ack <at> debbugs.gnu.org>
References: <87d139a81c.fsf@HIDDEN>
X-Gnu-PR-Message: ack 29786
X-Gnu-PR-Package: emacs
Reply-To: 29786 <at> debbugs.gnu.org
Date: Wed, 20 Dec 2017 12:39:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 29786 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
29786: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D29786
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#29786: 27.0.50; About the argument list of methods
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 27 Dec 2017 03:02:01 +0000
Resent-Message-ID: <handler.29786.B29786.15143436963993 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Michael Heerdegen <michael_heerdegen@HIDDEN>
Cc: 29786 <at> debbugs.gnu.org
From: Stefan Monnier <monnier@HIDDEN>
Message-ID: <jwvy3lo3o4z.fsf-monnier+bug#29786@HIDDEN>
References: <87d139a81c.fsf@HIDDEN>
Date: Tue, 26 Dec 2017 22:01:29 -0500
In-Reply-To: <87d139a81c.fsf@HIDDEN> (Michael Heerdegen's message of "Wed, 20
 Dec 2017 13:38:39 +0100")
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

> It's not clear to me what the sentence saying the argument lists must
> all be identical tries to say.  Surely they can't all be identical when
> they need to specify different specializers?

All that matters is that they should all accept the same number of arguments.

> (cl-defmethod seq-mapn (function (stream stream) &rest streams)
>   "Map FUNCTION over the STREAMS.
>
> Example: this prints the first ten Fibonacci numbers:
>
>   (letrec ((fibs (stream-cons
>                   1
>                   (stream-cons
>                    1
>                    (seq-mapn #'+ fibs (stream-rest fibs))))))
>     (seq-do #'print (seq-take fibs 10)))
>
> \(fn FUNCTION STREAMS...)"

I think this "\(fn FUNCTION STREAMS...)" thingy doesn't make sense for
`cl-defmethod`: it only makes sense for `cl-defgeneric`.

> (cl-defmethod seq-mapn (function (sequence stream) &rest sequences)
>   "Map FUNCTION over the STREAMS.
[...]
>     (seq-do #'print (seq-take fibs 10)))"
[...]
> That gives me for C-h f:
>
> Implementations:
>
> (sequence (arg1 stream) &rest sequences) in `~/software/elpa/packages/stream/stream.el'.

Oh, indeed, we have a bug in cl--generic-lambda:
We create a (cl-function (lambda (function stream &rest streams) ...)),
then macroexpand it, then retro-fit an additional `cnm` argument (the
implicit argument that holds the "next method", used by
cl-call-next-method).  But when we retro-fit this `cnm` argument, we're
not careful to update the potential (fn FOO) stuff added at the end of
the docstring.

Not sure how best to fix it,


        Stefan "who curses the idiot who came up with this gross (fn FOO) hack"

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#29786: 27.0.50; About the argument list of methods
Resent-From: Michael Heerdegen <michael_heerdegen@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 27 Dec 2017 12:30:02 +0000
Resent-Message-ID: <handler.29786.B29786.15143777791347 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Stefan Monnier <monnier@HIDDEN>
Cc: 29786 <at> debbugs.gnu.org
From: Michael Heerdegen <michael_heerdegen@HIDDEN>
References: <87d139a81c.fsf@HIDDEN> <jwvy3lo3o4z.fsf-monnier+bug#29786@HIDDEN>
Date: Wed, 27 Dec 2017 13:29:23 +0100
In-Reply-To: <jwvy3lo3o4z.fsf-monnier+bug#29786@HIDDEN> (Stefan Monnier's
 message of "Tue, 26 Dec 2017 22:01:29 -0500")
Message-ID: <87lghocq1o.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Stefan Monnier <monnier@HIDDEN> writes:

> > (cl-defmethod seq-mapn (function (stream stream) &rest streams)
> >   "Map FUNCTION over the STREAMS.
> >
> > Example: this prints the first ten Fibonacci numbers:
> >
> >   (letrec ((fibs (stream-cons
> >                   1
> >                   (stream-cons
> >                    1
> >                    (seq-mapn #'+ fibs (stream-rest fibs))))))
> >     (seq-do #'print (seq-take fibs 10)))
> >
> > \(fn FUNCTION STREAMS...)"
>
> I think this "\(fn FUNCTION STREAMS...)" thingy doesn't make sense for
> `cl-defmethod`: it only makes sense for `cl-defgeneric`.

But it does make sense in this example, no?


Thanks,

Michael.

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#29786: 27.0.50; About the argument list of methods
Resent-From: Stefan Monnier <monnier@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 27 Dec 2017 14:54:01 +0000
Resent-Message-ID: <handler.29786.B29786.151438638421990 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 29786
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: Michael Heerdegen <michael_heerdegen@HIDDEN>
Cc: 29786 <at> debbugs.gnu.org
Received: via spool by 29786-submit <at> debbugs.gnu.org id=B29786.151438638421990
          (code B ref 29786); Wed, 27 Dec 2017 14:54:01 +0000
Received: (at 29786) by debbugs.gnu.org; 27 Dec 2017 14:53:04 +0000
Received: from localhost ([127.0.0.1]:53242 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1eUD4o-0005iP-0G
	for submit <at> debbugs.gnu.org; Wed, 27 Dec 2017 09:53:04 -0500
Received: from chene.dit.umontreal.ca ([132.204.246.20]:35757)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <monnier@HIDDEN>) id 1eUD4m-0005iA-8a
 for 29786 <at> debbugs.gnu.org; Wed, 27 Dec 2017 09:53:01 -0500
Received: from ceviche.home (lechon.iro.umontreal.ca [132.204.27.242])
 by chene.dit.umontreal.ca (8.14.7/8.14.1) with ESMTP id vBREqvuF020250;
 Wed, 27 Dec 2017 09:52:58 -0500
Received: by ceviche.home (Postfix, from userid 20848)
 id 3E3CF66326; Wed, 27 Dec 2017 09:52:52 -0500 (EST)
From: Stefan Monnier <monnier@HIDDEN>
Message-ID: <jwvd130fcrp.fsf-monnier+emacs@HIDDEN>
References: <87d139a81c.fsf@HIDDEN>
 <jwvy3lo3o4z.fsf-monnier+bug#29786@HIDDEN> <87lghocq1o.fsf@HIDDEN>
Date: Wed, 27 Dec 2017 09:52:52 -0500
In-Reply-To: <87lghocq1o.fsf@HIDDEN> (Michael Heerdegen's message of "Wed, 27
 Dec 2017 13:29:23 +0100")
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-NAI-Spam-Flag: NO
X-NAI-Spam-Threshold: 5
X-NAI-Spam-Score: 0
X-NAI-Spam-Rules: 2 Rules triggered
	EDT_SA_DN_PASS=0, RV6188=0
X-NAI-Spam-Version: 2.3.0.9418 : core <6188> : inlines <6288> : streams
 <1774325> : uri <2558287>
X-Spam-Score: -1.3 (-)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.3 (-)

>> > (cl-defmethod seq-mapn (function (stream stream) &rest streams)
[...]
>> > \(fn FUNCTION STREAMS...)"
>> I think this "\(fn FUNCTION STREAMS...)" thingy doesn't make sense for
>> `cl-defmethod`: it only makes sense for `cl-defgeneric`.
> But it does make sense in this example, no?

Not really, no: in the docstring of `seq-mapn` what we want to show to
the user about the above method is when it applies, i.e. its
"specializers".  We could try to make it say that the specializer is
"all args after `function` are of type `stream`", but there's no
standard format to express that.  We could invent one, like

    (seq-mapn FUNCTION &rest (STREAMS (list stream)))
or
    (seq-mapn FUNCTION (STREAM stream) ...)

but it seems like more trouble than it's worth.


        Stefan

Last modified: Mon, 25 Nov 2019 12:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.