mirror of
https://github.com/abo-abo/avy.git
synced 2025-10-13 13:33:03 +00:00
Update description to be easier to understand.
This commit is contained in:
parent
36f768d9e3
commit
9103291214
26
avy.el
26
avy.el
@ -1,4 +1,4 @@
|
|||||||
;;; avy.el --- tree-based completion -*- lexical-binding: t -*-
|
;;; avy.el --- Jump to arbitrary positions in visible text and select text quickly. -*- lexical-binding: t -*-
|
||||||
|
|
||||||
;; Copyright (C) 2015 Free Software Foundation, Inc.
|
;; Copyright (C) 2015 Free Software Foundation, Inc.
|
||||||
|
|
||||||
@ -25,15 +25,23 @@
|
|||||||
|
|
||||||
;;; Commentary:
|
;;; Commentary:
|
||||||
;;
|
;;
|
||||||
;; This package provides a generic completion method based on building
|
;; With Avy, you can move point to any position in Emacs – even in a
|
||||||
;; a balanced decision tree with each candidate being a leaf. To
|
;; different window – using very few keystrokes. For this, you look at
|
||||||
;; traverse the tree from the root to a desired leaf, typically a
|
;; the position where you want point to be, invoke Avy, and then enter
|
||||||
;; sequence of `read-key' can be used.
|
;; the sequence of characters displayed at that position.
|
||||||
;;
|
;;
|
||||||
;; In order for `read-key' to make sense, the tree needs to be
|
;; If the position you want to jump to can be determined after only
|
||||||
;; visualized appropriately, with a character at each branch node. So
|
;; issuing a single keystroke, point is moved to the desired position
|
||||||
;; this completion method works only for things that you can see on
|
;; immediately after that keystroke. In case this isn't possible, the
|
||||||
;; your screen, all at once:
|
;; sequence of keystrokes you need to enter is comprised of more than
|
||||||
|
;; one character. Avy uses a decision tree where each candidate position
|
||||||
|
;; is a leaf and each edge is described by a character which is distinct
|
||||||
|
;; per level of the tree. By entering those characters, you navigate the
|
||||||
|
;; tree, quickly arriving at the desired candidate position, such that
|
||||||
|
;; Avy can move point to it.
|
||||||
|
;;
|
||||||
|
;; Note that this only makes sense for positions you are able to see
|
||||||
|
;; when invoking Avy. These kinds of positions are supported:
|
||||||
;;
|
;;
|
||||||
;; * character positions
|
;; * character positions
|
||||||
;; * word or subword start positions
|
;; * word or subword start positions
|
||||||
|
Loading…
x
Reference in New Issue
Block a user