[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#29328: 24.5; doc string of `transpose-subr`
From: |
Eli Zaretskii |
Subject: |
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 <drew.adams@oracle.com>
> Cc: 29328@debbugs.gnu.org
>
> > > 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.