]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve docstring of cl-check-type
authorStefan Kangas <stefankangas@gmail.com>
Sun, 2 Mar 2025 03:11:55 +0000 (04:11 +0100)
committerEshel Yaron <me@eshelyaron.com>
Tue, 4 Mar 2025 20:58:15 +0000 (21:58 +0100)
* lisp/emacs-lisp/cl-macs.el (cl-check-type): Improve docstring.

(cherry picked from commit 38cc36a375344d2518eb8f9d3e0e6943199da529)

lisp/emacs-lisp/cl-macs.el

index 84896239ba3c0d791c966de3b16ef40b673d7f47..c171c389aae8f34787923022b2432359c381298e 100644 (file)
@@ -3526,7 +3526,10 @@ Of course, we really can't know that for sure, so it's just a heuristic."
 ;;;###autoload
 (defmacro cl-check-type (form type &optional string)
   "Verify that FORM is of type TYPE; signal an error if not.
-STRING is an optional description of the desired type."
+STRING is an optional description of the desired type.
+
+Hint: To check the type of an object, use `cl-type-of'.
+To define new types, see `cl-deftype'."
   (declare (debug (place cl-type-spec &optional stringp)))
   (and (or (not (macroexp-compiling-p))
           (< cl--optimize-speed 3) (= cl--optimize-safety 3))