[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 269c8a0 1/3: Minor improvements to checkdoc
From: |
Stefan Kangas |
Subject: |
master 269c8a0 1/3: Minor improvements to checkdoc |
Date: |
Tue, 14 Sep 2021 01:57:43 -0400 (EDT) |
branch: master
commit 269c8a0b633ac22472772a7d4cce99228a5357ba
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
Minor improvements to checkdoc
* lisp/emacs-lisp/checkdoc.el (checkdoc-symbol-words): Add ignored
values.
(checkdoc-proper-noun-list): Remove XEmacs from list of words to
capitalize; there is little need to insist on consistency here.
(checkdoc-in-abbreviation-p): Add abbreviation "etc." and sort entries
alphabetically.
---
lisp/emacs-lisp/checkdoc.el | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 1ab44e0..bc568f1 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -304,11 +304,12 @@ variable `checkdoc-common-verbs-wrong-voice' if you wish
to add your own."
Do not set this by hand, use a function like `checkdoc-current-buffer'
with a universal argument.")
-(defcustom checkdoc-symbol-words nil
+(defcustom checkdoc-symbol-words '("byte-code" "command-line" "top-level")
"A list of symbol names (strings) which also happen to make good words.
These words are ignored when unquoted symbols are searched for.
This should be set in an Emacs Lisp file's local variables."
- :type '(repeat (symbol :tag "Word")))
+ :type '(repeat (symbol :tag "Word"))
+ :version "28.1")
;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable
#'checkdoc-list-of-strings-p)
;;;###autoload
@@ -320,7 +321,7 @@ This should be set in an Emacs Lisp file's local variables."
(not (memq nil (mapcar #'stringp obj)))))
(defvar checkdoc-proper-noun-list
- '("ispell" "xemacs" "emacs" "lisp")
+ '("ispell" "emacs" "lisp")
"List of words (not capitalized) which should be capitalized.")
(defvar checkdoc-proper-noun-regexp
@@ -2016,10 +2017,11 @@ Examples of abbreviations handled: \"e.g.\", \"i.e.\",
\"cf.\"."
;; so we need to skip it here too.
(? "\\(")
;; The abbreviations:
- (or (seq (any "iI") "." (any "eE")) ; i.e.
- (seq (any "eE") ".g") ; e.g.
- (seq (any "cC") "f"))) ; c.f.
- "vs") ; vs.
+ (or (seq (any "cC") "f") ; cf.
+ (seq (any "eE") ".g") ; e.g.
+ (seq (any "iI") "." (any "eE")))) ; i.e.
+ "etc" ; etc.
+ "vs") ; vs.
".")))
(error t))))