GNU bug report logs - #15506
24.3; checkdoc docstrings "non-nil"

Previous Next

Package: emacs;

Reported by: Kevin Ryde <user42 <at> zip.com.au>

Date: Wed, 2 Oct 2013 04:19:01 UTC

Severity: wishlist

Tags: fixed, patch

Found in version 24.3

Fixed in version 26.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log

Message #14 received at 15506 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: user42 <at> zip.com.au, 15506 <at> debbugs.gnu.org
Subject: Re: bug#15506: 24.3; checkdoc docstrings "non-nil"
Date: Thu, 25 Feb 2016 16:16:55 +1030

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Lars Ingebrigtsen <larsi <at> gnus.org>
>> Date: Wed, 24 Feb 2016 15:05:11 +1100
>> Cc: 15506 <at> debbugs.gnu.org
>> 
>> Kevin Ryde <user42 <at> zip.com.au> writes:
>> 
>> > This is an idea to have checkdoc propose "non-nil" at the start of
>> > docstrings, rather than "true".
>> >
>> > For variables this is per the last tip in "(elisp)Documentation Tips".
>> > The functions bit extends on similar lines.
>> >
>> > Maybe the function form could report further variations, eg. `eventp'
>> > starts "True if the argument ...".
>> 
>> I think this makes sense.  Any objections to applying?
>
> None here.

I've now applied this to the Emacs trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
This bug report was last modified 8 years and 232 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.