[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 9103291 048/110: Update description to be easier to unders
From: |
Oleh Krehel |
Subject: |
[elpa] master 9103291 048/110: Update description to be easier to understand. |
Date: |
Sat, 11 May 2019 10:15:41 -0400 (EDT) |
branch: master
commit 91032912146f16c09987d8d35083f09809d6afaa
Author: Christoph Michelbach <address@hidden>
Commit: Christoph Michelbach <address@hidden>
Update description to be easier to understand.
---
avy.el | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/avy.el b/avy.el
index 63b9590..70e1ca4 100644
--- a/avy.el
+++ b/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.
@@ -25,15 +25,23 @@
;;; Commentary:
;;
-;; This package provides a generic completion method based on building
-;; a balanced decision tree with each candidate being a leaf. To
-;; traverse the tree from the root to a desired leaf, typically a
-;; sequence of `read-key' can be used.
+;; With Avy, you can move point to any position in Emacs – even in a
+;; different window – using very few keystrokes. For this, you look at
+;; the position where you want point to be, invoke Avy, and then enter
+;; the sequence of characters displayed at that position.
;;
-;; In order for `read-key' to make sense, the tree needs to be
-;; visualized appropriately, with a character at each branch node. So
-;; this completion method works only for things that you can see on
-;; your screen, all at once:
+;; If the position you want to jump to can be determined after only
+;; issuing a single keystroke, point is moved to the desired position
+;; immediately after that keystroke. In case this isn't possible, the
+;; 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
;; * word or subword start positions
- [elpa] master ddf3c58 052/110: avy.el (avy-handler-default): Fix typo, (continued)
- [elpa] master ddf3c58 052/110: avy.el (avy-handler-default): Fix typo, Oleh Krehel, 2019/05/11
- [elpa] master a0ce6a7 050/110: Add avy-mouse-event-window and fix typo, Oleh Krehel, 2019/05/11
- [elpa] master 9489ca9 062/110: Add window selection via mouse button press and fix typo, Oleh Krehel, 2019/05/11
- [elpa] master 1b9f061 055/110: avy.el (avy-action-kill-stay): Adjust for avy-goto-line, Oleh Krehel, 2019/05/11
- [elpa] master dee0284 056/110: avy.el (avy-action-kill-move): Adjust for avy-goto-line, Oleh Krehel, 2019/05/11
- [elpa] master 56f6590 054/110: avy.el (avy-action-copy): Adjust for avy-goto-line, Oleh Krehel, 2019/05/11
- [elpa] master c08fc7c 049/110: Add option to match newline in avy-goto-char-timer, Oleh Krehel, 2019/05/11
- [elpa] master 245b5d6 046/110: avy.el: Fix compile warnings, Oleh Krehel, 2019/05/11
- [elpa] master 0ed6408 043/110: avy.el: Fix checkdoc warnings, Oleh Krehel, 2019/05/11
- [elpa] master 36f768d 047/110: avy.el (avy-words): Specify custom type, Oleh Krehel, 2019/05/11
- [elpa] master 9103291 048/110: Update description to be easier to understand.,
Oleh Krehel <=
- [elpa] master f4c45d3 044/110: avy.el: Add org-mode commands for jumping to and refiling headings, Oleh Krehel, 2019/05/11
- [elpa] master 4af1993 053/110: avy.el (avy-read): Update avy-current-path before returning, Oleh Krehel, 2019/05/11
- [elpa] master 176f34f 051/110: avy.el (avy-handler-default): Error msg on mouse clicks, Oleh Krehel, 2019/05/11
- [elpa] master 8556274 045/110: avy.el (avy-org-goto-heading-timer): Simplify, Oleh Krehel, 2019/05/11
- [elpa] master 83859c3 040/110: avy.el: Add new avy-style to use words as sequences, Oleh Krehel, 2019/05/11
- [elpa] master 240d717 041/110: Makefile: Add target checkdoc to check documentation guidelines of lisp files, Oleh Krehel, 2019/05/11
- [elpa] master 3980c03 035/110: avy.el (avy-move-region): Insert in original window, Oleh Krehel, 2019/05/11
- [elpa] master 54bce2c 036/110: avy.el (avy-move-region): Update, Oleh Krehel, 2019/05/11
- [elpa] master 49b070d 042/110: avy-test.el: Fix checkdoc warnings, Oleh Krehel, 2019/05/11
- [elpa] master 228ed97 039/110: avy.el (avy-action-teleport): Add and bind to "t", Oleh Krehel, 2019/05/11