branch: externals/bug-hunter
commit 36b0594de445c9f41c2260d785da2e76a1105946
Author: Artur Malabarba <[email protected]>
Commit: Artur Malabarba <[email protected]>
Update comments
---
README.org | 2 +-
bug-hunter.el | 43 +++++++++++++++++++------------------------
2 files changed, 20 insertions(+), 25 deletions(-)
diff --git a/README.org b/README.org
index 20e1e56..00d034c 100644
--- a/README.org
+++ b/README.org
@@ -3,7 +3,7 @@
The Bug Hunter is an Emacs library that finds the source of an error
-or unexpected behavior inside an elisp configuration file (tipically
+or unexpected behavior inside an elisp configuration file (typically
~init.el~ or ~.emacs~).
* Usage Examples
diff --git a/bug-hunter.el b/bug-hunter.el
index e0a35a9..bd3f771 100644
--- a/bug-hunter.el
+++ b/bug-hunter.el
@@ -22,55 +22,50 @@
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
-;; `bug-hunter' is an Emacs library that finds the source of an error or
+;;
+;; The Bug Hunter is an Emacs library that finds the source of an error or
;; unexpected behavior inside an elisp configuration file (typically
;; `init.el' or `.emacs').
-;;
-;;
+;;
;; Usage Examples
;; ==============
-;;
+;;
;; If your Emacs init file signals an error during startup, but you don’t
;; know why, simply issue
;; ,----
;; | M-x bug-hunter-init-file RET RET
;; `----
-;; and `bug-hunter' will find it for you.
-;;
+;; and The Bug Hunter will find it for you. Note that your `init.el' (or
+;; `.emacs') must be idempotent for this to work.
+;;
;; If Emacs starts up without errors but something is not working as it
;; should, invoke the same command, but give it in an assertion.
;; Essentially, if you can write a snippet that detects the issue and
;; returns non-nil, just provide this snippet as the assertion and the
;; Bug Hunter will do a bisection search for you.
-;;
+;;
;; For example, let’s say there’s something in your init file that’s
;; loading the `cl' library, and you don’t want that. You /know/ you’re
;; not loading it yourself, but how can you figure out which external
;; package is responsible for this outrage?
-;;
+;;
;; ,----
;; | M-x bug-hunter-init-file RET (featurep 'cl) RET
;; `----
-;;
+;;
;; *That’s it!* You’ll be given a nice buffer reporting the results:
-;;
+;;
;; - Are you getting obscure errors when trying to open /“.tex”/ files?
-;; Don’t despair! Just use `(find-file "dummy.tex")' as the assertion.
-;; - Did `ox-html' stop working due to some arcane misconfiguration? Just
-;; write an assertion that does an export and checks the result.
+;; - Don’t despair! Just use `(find-file "dummy.tex")' as the
+;; assertion.
+;; - Did `ox-html' stop working due to some arcane misconfiguration?
+;; - Just write an assertion that does an export and checks the result.
;; - Does some random command suddenly bind itself to `C-j' and you can’t
-;; figure out why? `(eq (key-binding "\n") 'unwanted-command)' is the
-;; assertion for you!
-;;
+;; figure out why?
+;; - `(eq (key-binding "\n") 'unwanted-command)' is the assertion for
+;; you!
+;;
;; Finally, you can also use `bug-hunter-file' to hunt in other files.
-;;
-
-;; Installation
-;; ============
-;;
-;; Bug Hunter will be on Melpa shortly. For now, do the following:
-;; 1. Open the `bug-hunter.el` file.
-;; 2. Issue `M-x package-install-from-buffer`.
;;; Code:
