emacs-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#42323: closed (26.3; Doc string of `seq-map')


From: GNU bug Tracking System
Subject: bug#42323: closed (26.3; Doc string of `seq-map')
Date: Sat, 25 Sep 2021 16:22:02 +0000

Your message dated Sat, 25 Sep 2021 19:21:35 +0300
with message-id <83y27kpqwg.fsf@gnu.org>
and subject line Re: bug#42323: [External] : Re: bug#42323: 26.3; Doc string of 
`seq-map'
has caused the debbugs.gnu.org bug report #42323,
regarding 26.3; Doc string of `seq-map'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
42323: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=42323
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
--- Begin Message --- Subject: 26.3; Doc string of `seq-map' Date: Sat, 11 Jul 2020 09:01:25 -0700 (PDT)
C-h f seq-map

___

 seq-map is a compiled Lisp function in 'seq.el'.

 (seq-map FUNCTION SEQUENCE)

 Return the result of applying FUNCTION to each element of SEQUENCE.

 This is a generic function.

 Implementations:

 (function (sequence sequence)) in 'seq.el'.

 Undocumented

 (function sequence) in 'seq.el'.

 Undocumented
___

This doc doesn't stand on its own at all, beyond the first line.  It
doesn't look other Emacs doc strings.  It reads like some text generated
primitively by computer, with no real care about readers/users.

You can't have a clue about what "Implementations:" means, or the
individual implementation descriptions mean, unless you know about
`cl-defgeneric' and `cl-defmethod'.

At the very least there should be some link to the doc of those, or
(preferably) a description of what's involved by saying "This is a
generic function" - IF that's really necessary to understanding
`seq-map'.

Elisp users shouldn't be expected to be proficient in Common Lisp.  They
should be able to use and understand a function such as `seq-map'
without caring about its implementation.  seq.el constructs should be
describable and described on their own, ideally without requiring users
to dig into Common Lisp constructs.

Or IF understanding the implementation is really necessary, then the
fact that seq.el is implemented using cl constructs can't be elided.  Is
that really the case?  What we have now is a pretty useless, and quite
confusing, indirect/implicit reference to a cl implementation.  Why?
How is that helpful?


In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.18362
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''



--- End Message ---
--- Begin Message --- Subject: Re: bug#42323: [External] : Re: bug#42323: 26.3; Doc string of `seq-map' Date: Sat, 25 Sep 2021 19:21:35 +0300
> From: Drew Adams <drew.adams@oracle.com>
> Date: Sat, 25 Sep 2021 16:10:06 +0000
> Cc: "42323@debbugs.gnu.org" <42323@debbugs.gnu.org>
> 
> > These details are now moved to the bottom of the help screen, below the
> > information that is immediately relevant.  Without a major re-design of
> > the help screen, I think that's as good as it gets for now:
> > ...
> > 
> > I suggest closing this bug report as fixed in 28.1.
> 
> I don't see how what you show fixes the bug in any
> sense at all.  If the bug can't be fixed now, or no
> one has the energy or motivation to fix it now, that
> doesn't change the fact that the bug exists.
> 
> It's not fixed, IMO.  Your options, as I see it, are
> (1) close as "won't fix" or (2) leave it open, in
> hopes that someone, at some time, will find the will
> and a way to fix it, and will do so.

I see no reason to continue the bikeshedding.  This bug is fixed, so
I'm closing it.


--- End Message ---

reply via email to

[Prev in Thread] Current Thread [Next in Thread]