all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 29328-done@debbugs.gnu.org
Subject: bug#29328: 24.5; doc string of `transpose-subr`
Date: Fri, 17 Nov 2017 17:45:30 +0200	[thread overview]
Message-ID: <83o9o0hpt1.fsf@gnu.org> (raw)
In-Reply-To: <93f79e75-eac2-406c-b483-5bf60020a7e4@default> (message from Drew Adams on Fri, 17 Nov 2017 07:02:22 -0800 (PST))

> 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.





      parent reply	other threads:[~2017-11-17 15:45 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-16 22:41 bug#29328: 24.5; doc string of `transpose-subr` Drew Adams
2017-11-17 13:46 ` Eli Zaretskii
2017-11-17 14:25   ` Robert Pluim
2017-11-17 14:57     ` Eli Zaretskii
2017-11-17 15:02   ` Drew Adams
2017-11-17 15:23     ` Noam Postavsky
2017-11-17 15:36       ` Drew Adams
2017-11-17 15:47       ` Eli Zaretskii
2017-11-17 15:45     ` Eli Zaretskii [this message]

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=83o9o0hpt1.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=29328-done@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    /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.