bug#15506: 24.3; checkdoc docstrings "non-nil"

[Kevin Ryde]

Severity: wishlist
Tags: patch

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 ...".

2013-10-02  Kevin Ryde  <user42@zip.com.au>

        * checkdoc.el (checkdoc-this-string-valid-engine): Docstrings for
        variables "True...", and functions "Return true...", should usually be
        "non-nil".

checkdoc.el.non-nil.diff
Description: Text Data

In GNU Emacs 24.3.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2013-05-29 on blah.blah, modified by Debian
System Description:     Debian GNU/Linux unstable (sid)

Configured using:
 `configure '--build' 'i486-linux-gnu' '--build' 'i486-linux-gnu'
 '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib'
 '--localstatedir=/var/lib' '--infodir=/usr/share/info'
 '--mandir=/usr/share/man' '--with-pop=yes'
 
'--enable-locallisppath=/etc/emacs24:/etc/emacs:/usr/local/share/emacs/24.3/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.3/site-lisp:/usr/share/emacs/site-lisp'
 '--with-crt-dir=/usr/lib/i386-linux-gnu' '--with-x=yes'
 '--with-x-toolkit=lucid' '--with-toolkit-scroll-bars' '--without-gconf'
 'build_alias=i486-linux-gnu' 'CFLAGS=-g -O2 -fstack-protector
 --param=ssp-buffer-size=4 -Wformat -Werror=format-security -Wall'
 'LDFLAGS=-Wl,-z,relro -Wl,-znocombreloc'
 'CPPFLAGS=-D_FORTIFY_SOURCE=2''

Important settings:
  value of $LANG: en_AU
  locale-coding-system: iso-latin-1-unix
  default enable-multibyte-characters: t