From: Stefan Kangas <stefankangas@gmail.com>
Date: Sun, 2 Mar 2025 03:11:55 +0000 (+0100)
Subject: ; Improve docstring of cl-check-type
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c7f984b68ef8afbf69640913f14756e598f42b0e;p=emacs.git

; Improve docstring of cl-check-type

* lisp/emacs-lisp/cl-macs.el (cl-check-type): Improve docstring.

(cherry picked from commit 38cc36a375344d2518eb8f9d3e0e6943199da529)
---

diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el
index 84896239ba3..c171c389aae 100644
--- a/lisp/emacs-lisp/cl-macs.el
+++ b/lisp/emacs-lisp/cl-macs.el
@@ -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))