bug#4818: 23.1; checkdoc noun at end of sentence

bug#4818: 23.1; checkdoc noun at end of sentence

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 671 bytes --]

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  <user42@zip.com.au>

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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: checkdoc.el.noun-end-sentence.diff --]
[-- Type: text/x-diff, Size: 794 bytes --]

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

[-- Attachment #3: foo.el --]
[-- Type: application/emacs-lisp, Size: 201 bytes --]

[-- Attachment #4: Type: text/plain, Size: 1076 bytes --]



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

bug#4818: marked as done (23.1; checkdoc noun at end of sentence)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 858 bytes --]

Your message dated Mon, 09 Nov 2009 09:02:34 +1100
with message-id <873a4osmit.fsf@blah.blah>
and subject line Re: 23.1; checkdoc noun at end of sentence
has caused the Emacs bug report #4818,
regarding 23.1; checkdoc noun at end of sentence
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
4818: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4818
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 5386 bytes --]

[-- Attachment #2.1.1: Type: text/plain, Size: 671 bytes --]

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  <user42@zip.com.au>

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


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2.1.2: checkdoc.el.noun-end-sentence.diff --]
[-- Type: text/x-diff, Size: 794 bytes --]

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

[-- Attachment #2.1.3: foo.el --]
[-- Type: application/emacs-lisp, Size: 201 bytes --]

[-- Attachment #2.1.4: Type: text/plain, Size: 1076 bytes --]



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

[-- Attachment #3: Type: message/rfc822, Size: 1792 bytes --]

From: Kevin Ryde <user42@zip.com.au>
To: 4818-done@emacsbugs.donarmstrong.com
Cc: Chong Yidong <cyd@stupidchicken.com>
Subject: Re: 23.1; checkdoc noun at end of sentence
Date: Mon, 09 Nov 2009 09:02:34 +1100
Message-ID: <873a4osmit.fsf@blah.blah>

Chong Yidong <cyd@stupidchicken.com> writes:
>
> Look OK, feel free to check in (and close this bug).

Beaut, done.