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

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

bug#18089: 24.4.50; doc string of `delete-selection-helper'


From: Lars Ingebrigtsen
Subject: bug#18089: 24.4.50; doc string of `delete-selection-helper'
Date: Sat, 30 Apr 2016 00:36:35 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux)

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





reply via email to

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