Variable: helpful-mode-hook

helpful-mode-hook is a variable defined in helpful.el.

Value

nil

Documentation

Hook run after entering Helpful mode.

No problems result if this variable is not bound. add-hook automatically binds it. (This is true for all hook variables.)

Source Code

;; Defined in ~/.emacs.d/elpa/helpful-20250408.334/helpful.el
(define-derived-mode helpful-mode special-mode "Helpful"
  "Major mode for *Helpful* buffers."
  (add-hook 'xref-backend-functions #'elisp--xref-backend nil t)

  (setq imenu-create-index-function #'helpful--imenu-index)
  ;; Prevent imenu converting "Source Code" to "Source.Code".
  (setq-local imenu-space-replacement " ")

  ;; Enable users to bookmark helpful buffers.
  (set (make-local-variable 'bookmark-make-record-function)
       #'helpful--bookmark-make-record)

  ;; Enable outline support for Emacs 29 and newer
  (unless (< emacs-major-version 29)
    (setq-local outline-search-function #'helpful--outline-function))

  ;; This function should normally only be called once after Org and
  ;; helpful are loaded. To avoid using `eval-after-load' (which is
  ;; only recommended in user init files), the function is called each
  ;; time the major mode is used.
  (helpful--add-support-for-org-links))