aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKarl Heuer1998-06-19 19:21:23 +0000
committerKarl Heuer1998-06-19 19:21:23 +0000
commit6deb154314c104ee5a77aafe240ff0088d316e65 (patch)
tree63089f22026c15d984aae61e5ea32b5cfbeff279
parentbd1cd4c2f896f9d4cadb19bf51ca91d3c9d3de11 (diff)
downloademacs-6deb154314c104ee5a77aafe240ff0088d316e65.tar.gz
emacs-6deb154314c104ee5a77aafe240ff0088d316e65.zip
(checkdoc-eval-defun): Doc fix.
(checkdoc-continue, checkdoc-tripple-semi-comment-check-flag): Ditto. (checkdoc-common-verbs-wrong-voice): Use dotted pairs.
-rw-r--r--lisp/emacs-lisp/checkdoc.el17
1 files changed, 8 insertions, 9 deletions
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index d38e4554b6c..6c68d17ed63 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -76,7 +76,7 @@
76;; 76;;
77;; Checking parameters 77;; Checking parameters
78;; 78;;
79;; You might not always want a function to have it's parameters listed 79;; You might not always want a function to have its parameters listed
80;; in order. When this is the case, put the following comment just in 80;; in order. When this is the case, put the following comment just in
81;; front of the documentation string: "; checkdoc-order: nil" This 81;; front of the documentation string: "; checkdoc-order: nil" This
82;; overrides the value of `checkdoc-arguments-in-order-flag'. 82;; overrides the value of `checkdoc-arguments-in-order-flag'.
@@ -173,7 +173,7 @@ comment can look like this:
173;; text 173;; text
174But when inside a function, code can be commented out using the ;;; 174But when inside a function, code can be commented out using the ;;;
175construct for all lines. When this variable is nil, the ;;; construct 175construct for all lines. When this variable is nil, the ;;; construct
176is ignored regardless of it's location in the code." 176is ignored regardless of its location in the code."
177 :group 'checkdoc 177 :group 'checkdoc
178 :type 'boolean) 178 :type 'boolean)
179 179
@@ -251,8 +251,8 @@ variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
251 '(("adds" . "add") 251 '(("adds" . "add")
252 ("allows" . "allow") 252 ("allows" . "allow")
253 ("appends" . "append") 253 ("appends" . "append")
254 ("applies" "apply") 254 ("applies" . "apply")
255 ("arranges" "arrange") 255 ("arranges" . "arrange")
256 ("brings" . "bring") 256 ("brings" . "bring")
257 ("calls" . "call") 257 ("calls" . "call")
258 ("catches" . "catch") 258 ("catches" . "catch")
@@ -263,7 +263,7 @@ variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
263 ("destroys" . "destroy") 263 ("destroys" . "destroy")
264 ("disables" . "disable") 264 ("disables" . "disable")
265 ("executes" . "execute") 265 ("executes" . "execute")
266 ("evals" . "evaluate") 266 ("evals" . "evaluate")
267 ("evaluates" . "evaluate") 267 ("evaluates" . "evaluate")
268 ("finds" . "find") 268 ("finds" . "find")
269 ("forces" . "force") 269 ("forces" . "force")
@@ -317,7 +317,7 @@ variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
317 ("tells" . "tell") 317 ("tells" . "tell")
318 ("tests" . "test") 318 ("tests" . "test")
319 ("toggles" . "toggle") 319 ("toggles" . "toggle")
320 ("tries" . "try") 320 ("tries" . "try")
321 ("turns" . "turn") 321 ("turns" . "turn")
322 ("undoes" . "undo") 322 ("undoes" . "undo")
323 ("unloads" . "unload") 323 ("unloads" . "unload")
@@ -532,8 +532,7 @@ a separate buffer."
532(defun checkdoc-continue (&optional take-notes) 532(defun checkdoc-continue (&optional take-notes)
533 "Find the next docstring in the current buffer which is stylisticly poor. 533 "Find the next docstring in the current buffer which is stylisticly poor.
534Prefix argument TAKE-NOTES means to continue through the whole buffer and 534Prefix argument TAKE-NOTES means to continue through the whole buffer and
535save warnings in a separate buffer. Second optional argument START-POINT 535save warnings in a separate buffer."
536is the starting location. If this is nil, `point-min' is used instead."
537 (interactive "P") 536 (interactive "P")
538 (let ((wrong nil) (msg nil) (errors nil) 537 (let ((wrong nil) (msg nil) (errors nil)
539 ;; Assign a flag to spellcheck flag 538 ;; Assign a flag to spellcheck flag
@@ -618,7 +617,7 @@ if there is one."
618 617
619;;;###autoload 618;;;###autoload
620(defun checkdoc-eval-defun () 619(defun checkdoc-eval-defun ()
621 "Evaluate the current form with `eval-defun' and check it's documentation. 620 "Evaluate the current form with `eval-defun' and check its documentation.
622Evaluation is done first so the form will be read before the 621Evaluation is done first so the form will be read before the
623documentation is checked. If there is a documentation error, then the display 622documentation is checked. If there is a documentation error, then the display
624of what was evaluated will be overwritten by the diagnostic message." 623of what was evaluated will be overwritten by the diagnostic message."