Function: apropos-safe-documentation

apropos-safe-documentation is a byte-compiled function defined in apropos.el.gz.

Signature

(apropos-safe-documentation FUNCTION)

Documentation

Like documentation, except it avoids calling get_doc_string.

Will return nil instead.

Source Code

;; Defined in /usr/src/emacs/lisp/apropos.el.gz
(defun apropos-safe-documentation (function)
  "Like `documentation', except it avoids calling `get_doc_string'.
Will return nil instead."
  (when (setq function (indirect-function function))
    ;; FIXME: `function-documentation' says not to call it, but `documentation'
    ;; would turn (FILE . POS) references into strings too eagerly, so
    ;; we do want to use the lower-level function.
    (let ((doc (function-documentation function)))
      ;; Docstrings from the DOC file are handled elsewhere.
      (if (integerp doc) nil doc))))