[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/flx e24352a502 074/182: add usage information
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/flx e24352a502 074/182: add usage information |
Date: |
Tue, 13 Dec 2022 03:59:31 -0500 (EST) |
branch: elpa/flx
commit e24352a502c8ada7cbc59bfb19b97235304267d6
Author: Le Wang <le.wang@agworld.com.au>
Commit: Le Wang <le.wang@agworld.com.au>
add usage information
fixes #33
---
README.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/README.md b/README.md
index 40942ba47b..541e377b2a 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,33 @@ This version will always be up-to-date.
user - `flx-ido` is already properly configured and ready for
action.
+## Usage
+
+The sorting algorithm is a balance between word beginnings (abbreviation) and
+contiguous matches (substring).
+
+The longer the substring match, the higher it scores. This maps well to how
+we think about matching.
+
+In general, it's better form queries wiht only **alphanumeric** characters so
+the sorting algorithm can do something smart.
+
+For example, if you have these files:
+
+ projects/clojure-mode/clojure-mode.el
+ projects/prelude/core/prelude-mode.el
+
+If the search term was "pre-mode", you might expect "prelude-mode.el" to be
+ranked higher. However because the substring match "re-mode" is so long,
+"clojure-mode.el" actually scores higher.
+
+
+Here, using "premode" would give the expected order
+
+### completing file names
+
+Matches within the basepath score higher.
+
## ido support
Add this to your init file and *flx* match will be enabled for ido.
- [nongnu] elpa/flx f3ccfc9168 049/182: make warning less dramatic, (continued)
- [nongnu] elpa/flx f3ccfc9168 049/182: make warning less dramatic, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx acf230e2c9 102/182: Lower default flx-ido-threshold -> 500., ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx a1ac8f97ec 034/182: fix `ido-merge-work-directories`, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx f068b2bc1f 056/182: Improve the formatting of the README and extend it a bit, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 1df93b286a 060/182: comment clarification, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx a15638e403 064/182: Merge pull request #26 from bbatsov/master, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx c41f9f5087 065/182: reorder README sections, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx d77b703c37 069/182: Merge pull request #28 from bbatsov/marmalade, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 0c41fc616d 072/182: update package install instrucations, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx ce2d375f82 073/182: Makefile: introduce all, clean targets, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx e24352a502 074/182: add usage information,
ELPA Syncer <=
- [nongnu] elpa/flx 6800cc34a9 076/182: flx-ido: fix comment in advice for ido-set-matches-1, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 4cd6d9c9e4 078/182: flx: require cl-lib; avoid ugly eval-when-compile, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 569beec178 080/182: Merge pull request #39 from artagnon/minor-cleanups, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 2903e5d2a7 084/182: Merge pull request #42 from bbatsov/byte-compile-warning, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 9440288782 086/182: Refactor to make prefix match clear., ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx a1fef07104 087/182: Fix C-k to kill buffer at head., ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 12589211c6 088/182: Implement case-fold searching, ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 80bb88c32f 092/182: Clean test .elcs but never compile them., ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 5591055c33 093/182: Recommend enabling ido-flex., ELPA Syncer, 2022/12/13
- [nongnu] elpa/flx 48ebd6c857 094/182: Make prefix-matchine one way., ELPA Syncer, 2022/12/13