Subject: bug#4818 closed by Kevin Ryde <[email-masked]> (Re: 23.1; checkdoc noun at end of sentence)

From: [email-masked] (Emacs bug Tracking System)
Date: Sun, 08 Nov 2009 22:10:05 +0000

This is an automatic notification regarding your bug report
which was filed against the emacs package:

#4818: 23.1; checkdoc noun at end of sentence

It has been closed by Kevin Ryde <[email-masked]>.

Their explanation is attached below along with your original report.
If this explanation is unsatisfactory and you have not received a
better one in a separate message then please contact Kevin Ryde <[email-masked]> by
replying to this email.

-- 
4818: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=4818
Emacs Bug Tracking System
Contact [email-masked] with problems

Subject: Re: 23.1; checkdoc noun at end of sentence
From: Kevin Ryde <[email-masked]>
To: [email-masked]
Cc: Chong Yidong <[email-masked]>
Date: Mon, 09 Nov 2009 09:02:34 +1100

Chong Yidong <[email-masked]> writes:
>
> Look OK, feel free to check in (and close this bug).

Beaut, done.

Subject: 23.1; checkdoc noun at end of sentence
From: Kevin Ryde <[email-masked]>
To: [email-masked]
Date: Wed, 28 Oct 2009 10:34:12 +1100

Running M-x checkdoc over the foo.el below I hoped it would ask to
capitalize "emacs" to "Emacs" in each of the three places.  A real-life
example can be found in `vi-save-all-and-exit' of vi.el.

I suspect the \\_> in checkdoc-proper-noun-regexp doesn't match a "." at
the end of a sentence.  Would relaxing that a bit like below cause any
false positives?

Incidentally, checkdoc-proper-noun-regexp could build its value with
regexp-opt could it?  Not that it needs to be optimized, just easier
than an explicit concatenating loop.

2009-10-27  Kevin Ryde  <[email-masked]>

	* emacs-lisp/checkdoc.el (checkdoc-proper-noun-regexp): Match noun
	at end of sentence.

--- checkdoc.el.~1.79.~	2009-10-28 09:39:24.000000000 +1100
+++ checkdoc.el	2009-10-28 10:25:24.000000000 +1100
@@ -331,12 +331,15 @@
   "List of words (not capitalized) which should be capitalized.")
 
 (defvar checkdoc-proper-noun-regexp
+  ;; "[.!?]" bit is for noun at end of a sentence, since those chars
+  ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
+  ;; The \" allows it to be the last sentence in a docstring too.
   (let ((expr "\\_<\\(")
 	(l checkdoc-proper-noun-list))
     (while l
       (setq expr (concat expr (car l) (if (cdr l) "\\|" ""))
 	    l (cdr l)))
-    (concat expr "\\)\\_>"))
+    (concat expr "\\)\\(\\_>\\|[.!?][ \t\n\"]\\)"))
   "Regular expression derived from `checkdoc-proper-noun-regexp'.")
 
 (defvar checkdoc-common-verbs-regexp nil

In GNU Emacs 23.1.1 (i486-pc-linux-gnu, GTK+ Version 2.16.5)
 of 2009-09-14 on raven, modified by Debian
configured using `configure  '--build=i486-linux-gnu' '--host=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/emacs23:/etc/emacs:/usr/local/share/emacs/23.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.1/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.1/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t