From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 24860-done@debbugs.gnu.org
Subject: bug#24860: 24.5; doc string of `transpose-sexps'
Date: Fri, 04 Nov 2016 11:58:11 +0200 [thread overview]
Message-ID: <8360o3lg7g.fsf@gnu.org> (raw)
In-Reply-To: <51926a3e-1aa2-417c-b354-ce0bb6499ba5@default> (message from Drew Adams on Wed, 2 Nov 2016 11:08:54 -0700 (PDT))
> Date: Wed, 2 Nov 2016 11:08:54 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
>
> 1. This part of the doc string is unclear. I have no idea what it is
> really trying to say.
>
> Does not work on a sexp that point is in the middle of
> if it is a list or string.
>
> What does "does not work" mean? Raises an error? Does something that
> we cannot describe? Does nothing?
Depending on what are the surrounding sexps and where point is, it
could do any of the above.
> When point is in the middle of a list it can also be between two sexps,
> which themselves could be lists: ((foo)|(bar)), with point at |. What
> "does not work" in that case, with an ARG of 1?
>
> This part of the doc is completely unclear.
Since the doc string starts by saying "Like M-t", its intent was to
contrast the behavior against that of transpose-words, where point
could be both between the words and in the middle of a word, in order
to have that word transposed with the next one. That doesn't work
with sexps.
> What's more, it is not mentioned in the Emacs manual (node
> `Expressions').
It is mentioned, in a way, because the manual says C-M-t is analogous
to C-t, i.e. it doesn't start from M-t.
I clarified this aspect in the doc string.
> 2. The doc string needs to say, as does the manual (node `Expressions'),
> that a zero ARG has particular behavior (and describe it) - it is not a
> no-op.
Added.
> 3. I think it would help for the manual (node `Expressions') to give a
> simple example showing the usefulness of the zero ARG case. It's not
> too clear from the description why this behavior is provided.
Volunteers are welcome to come up with useful examples, but I think
the bug report can now be closed, as the zero argument case doesn't
have examples in other similar commands as well.
Thanks.
prev parent reply other threads:[~2016-11-04 9:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-02 18:08 bug#24860: 24.5; doc string of `transpose-sexps' Drew Adams
2016-11-04 9:58 ` 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=8360o3lg7g.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=24860-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.