summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOleg Pykhalov <go.wigust@gmail.com>2018-05-02 19:05:50 +0300
committerOleg Pykhalov <go.wigust@gmail.com>2018-05-02 20:17:14 +0300
commitb2bf4f54adb08a6610bdc450f264cc5264a4460e (patch)
tree581d9b4180f58c9638e3972412e7ac93e1154417
parent8bc8efc753605e404c1efcdc5b53a780feb0760c (diff)
gnu: Add emacs-helpful.
* gnu/packages/emacs.scm (emacs-helpful): New public variable.
-rw-r--r--gnu/packages/emacs.scm39
1 files changed, 39 insertions, 0 deletions
diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
index 84e874b91c..b8b29dc599 100644
--- a/gnu/packages/emacs.scm
+++ b/gnu/packages/emacs.scm
@@ -9308,3 +9308,42 @@ downloading manager for Emacs.")
"This package provides an Emacs CSV mode, a major mode for editing
records in a generalized CSV (character-separated values) format.")
(license license:gpl3+)))
+
+(define-public emacs-helpful
+ (package
+ (name "emacs-helpful")
+ (version "0.1")
+ (source (origin
+ (method url-fetch)
+ (uri (string-append
+ "https://github.com/Wilfred/helpful/archive/"
+ version ".tar.gz"))
+ (file-name (string-append name "-" version ".tar.gz"))
+ (sha256
+ (base32
+ "16dx566qzrjj0bf43lnw7h1qlvgs94brqplamw8kppp2ylr72qs9"))))
+ (build-system emacs-build-system)
+ (propagated-inputs
+ `(("emacs-elisp-refs" ,emacs-elisp-refs)))
+ (home-page "https://github.com/Wilfred/helpful")
+ (synopsis "More contextual information in Emacs help")
+ (description "@code{helpful} is an alternative to the built-in Emacs help
+that provides much more contextual information.
+
+@itemize
+@item Show the source code for interactively defined functions (unlike the
+built-in Help).
+@item Fall back to the raw sexp if no source is available.
+@item Show where a function is being called.
+@item Docstrings will Highlight the summary (the first sentence), include
+cross-references, hide superfluous puncuation.
+@item Show you the properties that have been applied to the current
+symbol. This provides visibility of features like edebug or byte-code
+optimisation.
+@item Provide a separate @code{helpful-command} function to view interactive
+functions.
+@item Display any keybindings that apply to interactive functions.
+@item Trace, disassemble functions from inside Helpful. This is discoverable
+and doesn't require memorisation of commands.
+@end itemize\n")
+ (license license:gpl3+)))