Function: custom-face-documentation

custom-face-documentation is a byte-compiled function defined in cus-edit.el.gz.

Signature

(custom-face-documentation FACE)

Documentation

Return documentation of FACE for use in Custom buffer.

Source Code

;; Defined in /usr/src/emacs/lisp/cus-edit.el.gz
(defun custom-face-documentation (face)
  "Return documentation of FACE for use in Custom buffer."
  (format "%s%s" (face-documentation face)
          ;; This duplicates some code from describe-face.
          ;; TODO extract to separate utility function?
          ;; In practice this does not get used, because M-x customize-face
          ;; follows aliases.
          (let ((alias (get face 'face-alias))
                (obsolete (get face 'obsolete-face)))
            (if (and alias obsolete)
                (format "\nThis face is obsolete%s; use `%s' instead.\n"
                        (if (stringp obsolete)
                            (format " since %s" obsolete)
                          "")
                        alias)
              ""))))