diff options
| author | Wilfred Hughes <me@wilfred.me.uk> | 2017-06-03 17:45:24 +0100 |
|---|---|---|
| committer | Wilfred Hughes <me@wilfred.me.uk> | 2017-06-03 17:45:24 +0100 |
| commit | 1c6d5cb3d86d270d1a270b248f9cc15ae0a4d831 (patch) | |
| tree | 6dbf7d646d3a669a6173fc2cc3f0756f3198faae /README.md | |
| parent | 7ec5efdefed17f93e194a2b50615fbd9b38c6d4b (diff) | |
Expand commentary and readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 31 insertions, 5 deletions
@@ -1,16 +1,42 @@ # Helpful [](https://travis-ci.org/Wilfred/helpful) [](https://coveralls.io/github/Wilfred/helpful?branch=master) -A better Help buffer. +Helpful is an alternative to the built-in Emacs help that provides +much more contextual information. SCREENSHOT -Helpful will: +## Source code -Always **show the source code** of functions. It shows the +Helpful will try really hard to show the source code. It shows the source code for interactively defined functions (unlike the built-in Help) and falls back to the raw sexp if no source is available. -Display **symbol properties**. This provides visibility of features +## View Callers + +Helpful will show you where a function is being called! + +## Pretty Docstrings + +Helpful renders docstrings with full cross-references, hiding +superfluous punctuation. + +## Symbol Properties + +Helpful will show you the properties that have been applied to the +current symbol. This provides visibility of features like edebug or byte-code optimisation. -Show **references**. You can see where a function is being called! +## Describe Commands + +Helpful provides a separate `helpful-command` function, for when you +just want to view interactive functions. + +## View Keymaps + +Helpful displays any keybindings that apply to interactive functions. + +## Integrated Tooling + +You can trace, debug or disassemble functions from inside +Helpful. This is discoverable and doesn't require memorisation of +commands. |
