;;
;; Checking parameters
;;
-;; You might not always want a function to have it's parameters listed
+;; You might not always want a function to have its parameters listed
;; in order. When this is the case, put the following comment just in
;; front of the documentation string: "; checkdoc-order: nil" This
;; overrides the value of `checkdoc-arguments-in-order-flag'.
;; text
But when inside a function, code can be commented out using the ;;;
construct for all lines. When this variable is nil, the ;;; construct
-is ignored regardless of it's location in the code."
+is ignored regardless of its location in the code."
:group 'checkdoc
:type 'boolean)
'(("adds" . "add")
("allows" . "allow")
("appends" . "append")
- ("applies" "apply")
- ("arranges" "arrange")
+ ("applies" . "apply")
+ ("arranges" . "arrange")
("brings" . "bring")
("calls" . "call")
("catches" . "catch")
("destroys" . "destroy")
("disables" . "disable")
("executes" . "execute")
- ("evals" . "evaluate")
+ ("evals" . "evaluate")
("evaluates" . "evaluate")
("finds" . "find")
("forces" . "force")
("tells" . "tell")
("tests" . "test")
("toggles" . "toggle")
- ("tries" . "try")
+ ("tries" . "try")
("turns" . "turn")
("undoes" . "undo")
("unloads" . "unload")
(defun checkdoc-continue (&optional take-notes)
"Find the next docstring in the current buffer which is stylisticly poor.
Prefix argument TAKE-NOTES means to continue through the whole buffer and
-save warnings in a separate buffer. Second optional argument START-POINT
-is the starting location. If this is nil, `point-min' is used instead."
+save warnings in a separate buffer."
(interactive "P")
(let ((wrong nil) (msg nil) (errors nil)
;; Assign a flag to spellcheck flag
;;;###autoload
(defun checkdoc-eval-defun ()
- "Evaluate the current form with `eval-defun' and check it's documentation.
+ "Evaluate the current form with `eval-defun' and check its documentation.
Evaluation is done first so the form will be read before the
documentation is checked. If there is a documentation error, then the display
of what was evaluated will be overwritten by the diagnostic message."