File: helpful.el.html

Helpful is a replacement for *help* buffers that provides much more contextual information. To get started, try:
`M-x helpful-function RET helpful-function

The full set of commands you can try is:

* helpful-function
* helpful-command
* helpful-key
* helpful-macro
* helpful-callable
* helpful-variable
* helpful-at-point

For more information and screenshots, see https://github.com/wilfred/helpful

Defined variables (13)

helpful--associated-bufferThe buffer being used when showing inspecting
helpful--first-displayWhether this is the first time this results buffer has been
helpful--highlighting-funcsHighlighting functions that are safe to run in a temporary buffer.
helpful--start-bufferThe buffer we were originally called from.
helpful--view-literalWhether to show a value as a literal, or a pretty interactive
helpful-max-buffersHelpful will kill the least recently used Helpful buffer
helpful-max-highlightDon’t highlight code with more than this many characters.
helpful-mode-abbrev-tableAbbrev table for ‘helpful-mode’.
helpful-mode-hookHook run after entering ‘helpful-mode’.
helpful-mode-mapKeymap for ‘helpful-mode’.
helpful-mode-syntax-tableSyntax table for ‘helpful-mode’.
helpful-set-variable-functionFunction used by ‘helpful--set’ to interactively set variables.
helpful-switch-buffer-functionFunction called to display the *Helpful* buffer.

Defined functions (150)

helpful--add-support-for-org-links()
helpful--advised-p(SYM)
helpful--aliases(SYM CALLABLE-P)
helpful--all-keymap-syms()
helpful--all-references(BUTTON)
helpful--associated-buffer(BUTTON)
helpful--autoloaded-p(SYM BUF)
helpful--bookmark-jump(BOOKMARK)
helpful--bookmark-make-record()
helpful--bound-p(SYMBOL)
helpful--buffer(SYMBOL CALLABLE-P)
helpful--buffer-button(BUFFER &optional POS)
helpful--button(TEXT TYPE &rest PROPERTIES)
helpful--c-source-directory(BUTTON)
helpful--calculate-references(SYM CALLABLE-P SOURCE-PATH)
helpful--callees(FORM)
helpful--callees-1(FORM)
helpful--can-edebug-p(SYM CALLABLE-P BUF POS)
helpful--canonical-symbol(SYM CALLABLE-P)
helpful--chars-after(POS N)
helpful--chars-before(POS N)
helpful--compiled-p(SYM)
helpful--convert-c-name(SYMBOL VAR)
helpful--count-values(ITEMS)
helpful--customize(BUTTON)
helpful--definition(SYM CALLABLE-P)
helpful--describe(BUTTON)
helpful--describe-exactly(BUTTON)
helpful--disambiguate(SYM CHOICES)
helpful--disassemble(BUTTON)
helpful--display-callee-group(CALLEES)
helpful--docstring(SYM CALLABLE-P)
helpful--edebug(BUTTON)
helpful--edebug-p(SYM)
helpful--ensure-loaded()
helpful--find-by-macroexpanding(BUF SYM CALLABLE-P)
helpful--flash-region(START END)
helpful--follow-link(BUTTON)
helpful--forget(BUTTON)
helpful--format-alias(SYM CALLABLE-P)
helpful--format-argument(ARG)
helpful--format-closure(SYM FORM)
helpful--format-command-keys(DOCSTRING)
helpful--format-commands(STR KEYMAP)
helpful--format-docstring(DOCSTRING)
helpful--format-head(HEAD)
helpful--format-hook(HOOK-VAL)
helpful--format-keymap(KEYMAP)
helpful--format-keys(COMMAND-SYM ALIASES)
helpful--format-obsolete-info(SYM CALLABLE-P)
helpful--format-position-heads(POSITION-HEADS PATH)
helpful--format-properties(SYMBOL)
helpful--format-reference(HEAD LONGEST-HEAD REF-COUNT POSITION PATH)
helpful--format-symbol(SYM)
helpful--format-value(SYM VALUE)
helpful--goto-char-widen(POS)
helpful--has-shortdoc-p(SYM)
helpful--heading(TEXT)
helpful--hook-p(SYMBOL VALUE)
helpful--imenu-index()
helpful--in-manual-p(SYM)
helpful--indent-rigidly(S AMOUNT)
helpful--info(BUTTON)
helpful--insert-implementations()
helpful--insert-section-break()
helpful--join-and(ITEMS)
helpful--kbd-macro-p(SYM)
helpful--key-sequences(COMMAND-SYM KEYMAP GLOBAL-KEYCODES)
helpful--keymap-keys(KEYMAP)
helpful--keymaps-containing(COMMAND-SYM)
helpful--keymaps-containing-aliases(COMMAND-SYM ALIASES)
helpful--kind-name(SYMBOL CALLABLE-P)
helpful--library-path(LIBRARY-NAME)
helpful--macroexpand-try(FORM)
helpful--make-callees-button(SYM SOURCE)
helpful--make-customize-button(SYM)
helpful--make-disassemble-button(OBJ)
helpful--make-edebug-button(SYM)
helpful--make-forget-button(SYM CALLABLE-P)
helpful--make-manual-button(SYM)
helpful--make-references-button(SYM CALLABLE-P)
helpful--make-run-test-button(SYM)
helpful--make-set-button(SYM BUFFER)
helpful--make-shortdoc-sentence(SYM)
helpful--make-toggle-button(SYM BUFFER)
helpful--make-toggle-literal-button()
helpful--make-tracing-button(SYM)
helpful--manual(BUTTON)
helpful--merge-alists(L1 L2)
helpful--native-compiled-p(SYM)
helpful--navigate(BUTTON)
helpful--navigate-button(TEXT PATH &optional POS)
helpful--obsolete-info(SYM CALLABLE-P)
helpful--open-if-needed(PATH)
helpful--org-link-follow(LINK _)
helpful--org-link-store()
helpful--original-value(SYM)
helpful--original-value-differs-p(SYM)
helpful--outer-sexp(BUF POS)
helpful--outline-function(&optional BOUND MOVE BACKWARD LOOKING-AT)
helpful--prefer-helpful-when-following-org-link()
helpful--pretty-print(VALUE)
helpful--primitive-p(SYM CALLABLE-P)
helpful--propertize-bare-links(DOCSTRING)
helpful--propertize-info(DOCSTRING)
helpful--propertize-links(DOCSTRING)
helpful--propertize-sym-ref(SYM-NAME BEFORE-TXT AFTER-TXT)
helpful--read-live-buffer(PROMPT PREDICATE)
helpful--read-symbol(PROMPT DEFAULT-VAL PREDICATE)
helpful--reference-positions(SYM CALLABLE-P BUF)
helpful--run-test(BUTTON)
helpful--set(BUTTON)
helpful--shortdoc(BUTTON)
helpful--show-callees(BUTTON)
helpful--signature(SYM)
helpful--skip-advice(DOCSTRING)
helpful--sort-symbols(SYM-LIST)
helpful--source(SYM CALLABLE-P BUF POS)
helpful--split-first-line(DOCSTRING)
helpful--summary(SYM CALLABLE-P BUF POS)
helpful--support-storing-org-links()
helpful--switch-to-buffer(BUTTON)
helpful--sym-value(SYM BUF)
helpful--symbol-at-point()
helpful--symbol-at-point-exactly()
helpful--syntax-highlight(SOURCE &optional MODE)
helpful--toggle(BUTTON)
helpful--toggle-edebug(SYM)
helpful--trace(BUTTON)
helpful--tree-any-p(PRED TREE)
helpful--update-and-switch-buffer(SYMBOL CALLABLE-P)
helpful--variable-at-point()
helpful--variable-at-point-exactly()
helpful--variable-defined-at-point()
helpful--variable-p(SYMBOL)
helpful--version-info(SYM)
helpful--view-literal(BUTTON)
helpful--without-advice(SYM)
helpful-at-point()
helpful-callable(SYMBOL)
helpful-command(SYMBOL)
helpful-function(SYMBOL)
helpful-key(KEY-SEQUENCE)
helpful-kill-buffers()
helpful-macro(SYMBOL)
helpful-mode()
helpful-symbol(SYMBOL)
helpful-update()
helpful-variable(SYMBOL)
helpful-visit-reference()

Defined faces (1)

helpful-headingFace used for headings in Helpful buffers.