all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Noam Postavsky <npostavs@users.sourceforge.net>
Cc: 29328@debbugs.gnu.org
Subject: bug#29328: 24.5; doc string of `transpose-subr`
Date: Fri, 17 Nov 2017 07:36:28 -0800 (PST)	[thread overview]
Message-ID: <7ca7abc6-f456-419e-be2d-b3c06b45ca72@default> (raw)
In-Reply-To: <CAM-tV-_HbQiWty_zV2V72YNLrQWBvkz8tkRi2Ux0KeHpkBbetw@mail.gmail.com>

> >> > 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.  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?
> 
> How about something like this:
> -forward-paragraph).  If ARG is zero, exchanges the current object
> +forward-paragraph).  If SPECIAL is non-nil, then MOVER should
> +return the bounds of the object as a cons (BEG . END) instead.
> +If ARG is zero, exchanges the current object
>  with the one containing mark.  If ARG is an integer, moves the
>  current object past ARG following (if ARG is positive) or
>  preceding (if ARG is negative) objects, leaving point after the

If that's the behavior, fine with me.  I don't know
what the behavior is.

But the parameters should be described in order,
i.e., ARGS should be described before SPECIAL.





  reply	other threads:[~2017-11-17 15:36 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 [this message]
2017-11-17 15:47       ` Eli Zaretskii
2017-11-17 15:45     ` Eli Zaretskii

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=7ca7abc6-f456-419e-be2d-b3c06b45ca72@default \
    --to=drew.adams@oracle.com \
    --cc=29328@debbugs.gnu.org \
    --cc=npostavs@users.sourceforge.net \
    /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.