aboutsummaryrefslogtreecommitdiff
path: root/helpful.el
diff options
context:
space:
mode:
Diffstat (limited to 'helpful.el')
-rw-r--r--helpful.el17
1 files changed, 17 insertions, 0 deletions
diff --git a/helpful.el b/helpful.el
index dce7612..d24c8b2 100644
--- a/helpful.el
+++ b/helpful.el
@@ -31,6 +31,7 @@
;; * helpful-function
;; * helpful-command
;; * helpful-macro
+;; * helpful-at-point
;;
;; For more information and screenshots, see
;; https://github.com/wilfred/helpful
@@ -620,6 +621,22 @@ For example, \"(some-func FOO &optional BAR)\"."
(switch-to-buffer (helpful--buffer symbol))
(helpful-update))
+;;;###autoload
+(defun helpful-at-point ()
+ "Show help for the callable symbol at point."
+ (interactive)
+ (let ((symbol (symbol-at-point)))
+ (cond
+ ((null symbol)
+ ;; TODO: suggest looking at value help, or nearby symbols, or
+ ;; similarly named symbols
+ (user-error "No symbol found at point"))
+ ((not (fboundp symbol))
+ (user-error "%s is not a function or macro" symbol))
+ (t
+ (switch-to-buffer (helpful--buffer symbol))
+ (helpful-update)))))
+
(define-derived-mode helpful-mode special-mode "Helpful"
"Major mode for *Helpful* buffers."
(add-hook 'xref-backend-functions #'elisp--xref-backend nil t))