* bug#18089: 24.4.50; doc string of `delete-selection-helper'
@ 2014-07-23 16:45 Drew Adams
2016-04-29 22:36 ` Lars Ingebrigtsen
0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2014-07-23 16:45 UTC (permalink / raw)
To: 18089
1. Mention of the TYPE value `t' is incorrrect. It should be "non-nil",
everywhere, based on what the code actually does (and has always done).
2. For FUNCTION, it is not true that the return value should be "one of
the above values" (even if non-nil replaces t). The return value can
apparently also be another FUNCTION. So the doc string for FUNCTION
should say that the return value of FUNCTION should be a value
acceptable as TYPE.
3. All of the info in this doc string should be in the doc string of
`delete-selection-pre-hook', not in the "helper" function.
4. Doc string lines should be no wider than 70 columns (except the
first).
In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
of 2014-06-28 on ODIEONE
Bzr revision: 117431 rgm@gnu.org-20140628015517-eku6hj8mpgcvfnso
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --prefix=/c/Devel/emacs/snapshot/trunk
--enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
-Ic:/Devel/emacs/include''
^ permalink raw reply [flat|nested] 2+ messages in thread
* bug#18089: 24.4.50; doc string of `delete-selection-helper'
2014-07-23 16:45 bug#18089: 24.4.50; doc string of `delete-selection-helper' Drew Adams
@ 2016-04-29 22:36 ` Lars Ingebrigtsen
0 siblings, 0 replies; 2+ messages in thread
From: Lars Ingebrigtsen @ 2016-04-29 22:36 UTC (permalink / raw)
To: Drew Adams; +Cc: 18089
Drew Adams <drew.adams@oracle.com> writes:
> 1. Mention of the TYPE value `t' is incorrrect. It should be "non-nil",
> everywhere, based on what the code actually does (and has always done).
Ok; fixed.
> 2. For FUNCTION, it is not true that the return value should be "one of
> the above values" (even if non-nil replaces t). The return value can
> apparently also be another FUNCTION. So the doc string for FUNCTION
> should say that the return value of FUNCTION should be a value
> acceptable as TYPE.
Ditto.
> 3. All of the info in this doc string should be in the doc string of
> `delete-selection-pre-hook', not in the "helper" function.
Perhaps... but it has a link to the helper function, and I think it's
nice that the helper function has this documentation. So no.
> 4. Doc string lines should be no wider than 70 columns (except the
> first).
Fixed.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2016-04-29 22:36 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-07-23 16:45 bug#18089: 24.4.50; doc string of `delete-selection-helper' Drew Adams
2016-04-29 22:36 ` Lars Ingebrigtsen
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).