unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Drew Adams <drew.adams@oracle.com>
Cc: Michael Heerdegen <michael_heerdegen@web.de>,
	Nicolas Petton <nicolas@petton.fr>,
	24014@debbugs.gnu.org
Subject: bug#24014: 24.5; doc string of `cl-reduce'
Date: Sat, 23 Oct 2021 10:32:31 -0700	[thread overview]
Message-ID: <CADwFkmkgRfxKiJBWXnsEB4zSwr2XBy80t16CjwYdLQ60NasK0A@mail.gmail.com> (raw)
In-Reply-To: <fcc90aa4-6300-4934-9c90-68448e61e443@default> (Drew Adams's message of "Sun, 17 Jul 2016 21:44:50 -0700 (PDT)")

close 24014 28.1
thanks

Drew Adams <drew.adams@oracle.com> writes:

>> >> 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.
>>
>> The documentation of `seq-reduce' is probably not perfect, but at least
>> it tries to explain what reducing means:
>>
>>     Return the result of calling FUNCTION with INITIAL-VALUE and the
>>     first element of SEQUENCE, then calling FUNCTION with that result and
>>     the second element of SEQUENCE, then with that result and the third
>>     element of SEQUENCE, etc.
>>
>>     If SEQUENCE is empty, return INITIAL-VALUE and FUNCTION is not called.
>
> Much better, yes.  This is the right level at which to describe what
> it does for most programmers, IMO.

Nicolas updated the docstring, and I have now done the same change in
cl.texi on the emacs-28 branch (commit 43914ab01f).

It is the same text as above, just formatted for texinfo, so it should
be understandable to us mere programmers.

I'm consequently closing this bug report.





  parent reply	other threads:[~2021-10-23 17:32 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 [this message]
2016-07-18  4:41   ` Drew Adams
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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CADwFkmkgRfxKiJBWXnsEB4zSwr2XBy80t16CjwYdLQ60NasK0A@mail.gmail.com \
    --to=stefan@marxist.se \
    --cc=24014@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=michael_heerdegen@web.de \
    --cc=nicolas@petton.fr \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).