From: Drew Adams <drew.adams@oracle.com>
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: 24014@debbugs.gnu.org
Subject: bug#24014: 24.5; doc string of `cl-reduce'
Date: Sun, 17 Jul 2016 21:41:42 -0700 (PDT) [thread overview]
Message-ID: <cbe75c95-be32-4349-992a-b72b1b785de6@default> (raw)
In-Reply-To: <87zipgmf51.fsf@web.de>
> > Please state in the doc string what the function does. IOW,
> > explain/describe/specify what "reduce" means. Do not suppose that Emacs
> > Lisp users are all familiar with functional programming etc.
> >
> > If _you_ understand it, you should be able to describe it in a couple of
> > sentences. It's not a complicated thing, but just repeating the word
> > "reduce" from the function name is not sufficient - not helpful.
>
> I also find the explanation in the manual confusing:
>
> "This function combines the elements of SEQ using an associative
> binary operation."
>
> The function does _not_ need to be associative. The sentence later:
>
> "If ‘:from-end’ is true, the reduction is right-associative instead
> of left-associative."
>
> makes sense, of course, but above, the word "associative" does not mean
> more than "any", and without reading the later text, it can easily be
> misunderstood.
Yes, and even when such text is corrected, it is not necessarily
understandable by many users. We should not assume that users
are math majors.
Even providing a functional-programming definition of `reduce' is
better than just describing it in abstract terms, if we can't come
up with a more down-to-earth description.
next prev parent reply other threads:[~2016-07-18 4:41 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-17 14:55 bug#24014: 24.5; doc string of `cl-reduce' Drew Adams
2016-07-17 15:57 ` Michael Heerdegen
2016-07-17 21:18 ` Nicolas Petton
2016-07-18 4:44 ` Drew Adams
2016-07-18 12:19 ` Nicolas Petton
2021-10-23 17:32 ` Stefan Kangas
2016-07-18 4:41 ` Drew Adams [this message]
2016-07-18 8:54 ` Clément Pit--Claudel
2016-07-18 14:02 ` Drew Adams
2016-07-18 16:03 ` Clément Pit--Claudel
2016-07-18 17:28 ` Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cbe75c95-be32-4349-992a-b72b1b785de6@default \
--to=drew.adams@oracle.com \
--cc=24014@debbugs.gnu.org \
--cc=michael_heerdegen@web.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.