emacs-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[debbugs-tracker] bug#3249: closed (23.0.93; doc of transpose-subr and t


From: GNU bug Tracking System
Subject: [debbugs-tracker] bug#3249: closed (23.0.93; doc of transpose-subr and transpose-regions)
Date: Sat, 28 Jan 2012 03:58:01 +0000

Your message dated Sat, 28 Jan 2012 11:56:38 +0800
with message-id <address@hidden>
and subject line Re: 23.0.93; doc of transpose-subr and transpose-regions
has caused the debbugs.gnu.org bug report #3249,
regarding 23.0.93; doc of transpose-subr and transpose-regions
to be marked as done.

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


-- 
3249: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3249
GNU Bug Tracking System
Contact address@hidden with problems
--- Begin Message --- Subject: 23.0.93; doc of transpose-subr and transpose-regions Date: Sat, 9 May 2009 08:56:59 -0700
It seems that all transpose functions in Emacs are defined using
`transpose-subr'.  If you want to define your own transpose function,
then you will presumably use `transpose-subr' too.
 
But `transpose-subr' is not even documented, making it that much
harder to try to use it to define your own transpose function.  Please
add a helpful doc string.
 
It's apparently not as simple as providing a `forward-*' function and
a numeric arg N to `transpose-subr'.  That's what `transpose-chars',
`transpose-words', `transpose-paragraphs', and `transpose-sentences do
(using `forward-char' etc.), but that apparently is not adequate for
`transpose-lines' or `transpose-sexps'.
 
So it would, in particular, be helpful to know just what is needed as
the MOVER arg of `transpose-subr'.
 
Also, the Elisp manual, node Transposition, mentions only
`transpose-regions', saying that it is used by the transposition
commands.  But it is not - the transposition commands all use
`transpose-subr', and that doesn't even call `transpose-regions'
indirectly.
 
`transpose-regions' is used in the Elisp source code in only 4 places,
in deuglify.el, mule-diag.el, and hanoi.el - never to define a
transpose command.  And `transpose-subr' is used in just as many
files, not counting simple.el.
 
So what is the correct advice to give Elisp programmers who want to
define transpose functions?  Shouldn't `transpose-subr' be documented
in the Elisp manual, in addition to getting a doc string?
 
Also, why is `transpose-regions' still defined in C code? Is that
necessary for performance?
 

In GNU Emacs 23.0.93.1 (i386-mingw-nt5.1.2600)
 of 2009-05-02 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 




--- End Message ---
--- Begin Message --- Subject: Re: 23.0.93; doc of transpose-subr and transpose-regions Date: Sat, 28 Jan 2012 11:56:38 +0800
> `transpose-subr' is not even documented, making it that much harder to
> try to use it to define your own transpose function.  Please add a
> helpful doc string.

Glenn wrote a docstring for transpose-subr several months ago.  Closing.


--- End Message ---

reply via email to

[Prev in Thread] Current Thread [Next in Thread]