search

abo-abo / avy

Jump to things in Emacs tree-style
1.72k stars 110 forks source link

Rephrase misleading instruction in README.md #222

Closed m1cm1c closed 6 years ago

m1cm1c commented 6 years ago

(avy-setup-default) only creates a single bind and the README shouldn't make it sound like it does more.

This is code it executes:

;;;###autoload
(defun avy-setup-default ()
  "Setup the default shortcuts."
  (eval-after-load "isearch"
    '(define-key isearch-mode-map (kbd "C-'") 'avy-isearch)))
abo-abo commented 6 years ago

I don't consider it misleading. Just because only C-' is bound currently doesn't mean more things can't be bound in the future. Nor do we have to describe every single binding in README, one example will do.