[debbugs-tracker] bug#29328: closed (24.5; doc string of `transpose-subr`)

[GNU bug Tracking System]

Your message dated Fri, 17 Nov 2017 17:45:30 +0200
with message-id <address@hidden>
and subject line Re: bug#29328: 24.5; doc string of `transpose-subr`
has caused the debbugs.gnu.org bug report #29328,
regarding 24.5; doc string of `transpose-subr`
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
29328: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=29328
GNU Bug Tracking System
Contact address@hidden with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> 24.5; doc string of `transpose-subr`
>
>
>
>
> Date: 
>
> Thu, 16 Nov 2017 14:41:40 -0800 (PST)
>
>
>
>
> The doc string should describe each parameter.  Parameter SPECIAL is not
> described, and its name is not specific or enlightening.
>
> See http://lists.gnu.org/archive/html/help-gnu-emacs/2017-11/msg00190.html
>
>
>
> In GNU Emacs 24.5.1 (i686-pc-mingw32)
>  of 2015-04-11 on LEG570
> Windowing system distributor `Microsoft Corp.', version 6.1.7601
> Configured using:
>  `configure --prefix=/c/usr --host=i686-pc-mingw32'
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#29328: 24.5; doc string of `transpose-subr`
>
>
>
>
> Date: 
>
> Fri, 17 Nov 2017 17:45:30 +0200
>
>
>
>
> > Date: Fri, 17 Nov 2017 07:02:22 -0800 (PST)
> > From: Drew Adams <address@hidden>
> > Cc: address@hidden
> > 
> > > > The doc string should describe each parameter.  Parameter SPECIAL is
> > > > not described, and its name is not specific or enlightening.
> > > 
> > > I don't see how it can be meaningfully documented.
> > 
> > That's tantamount to saying that the parameter has no meaning,
> > no behavior.
>
> No, it isn't.  It's tantamount to saying what I have just said.
>
> > If it does something then that something should
> > be describable, in some way, at least.  The place to start is
> > with the intention - why do we have such a parameter?  What
> > does it let you do?  Why/when would code ever make use of it?
>
> Thanks for the lecture.  Rest assured, I asked myself all of those
> questions, and then some.  This is an internal subroutine, so it
> doesn't have to document everything.
>
> Please accept my judgment on this.
>
>
> --- End Message ---