[nongnu] elpa/flx f589b237b8 172/182: Add a proper library commentary

[ELPA Syncer]

branch: elpa/flx
commit f589b237b86926ddf55cac98b88469c408cbcbb4
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    Add a proper library commentary
    
    The purpose of the library commentary is to inform users about the
    purpose of the library/package.  Add such a description, lifting
    text from the readme file, and move the implementation notes into
    ts own outline section.
---
 flx.el | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/flx.el b/flx.el
index a28202d88b..43a337b8e1 100644
--- a/flx.el
+++ b/flx.el
@@ -31,8 +31,18 @@
 
 ;;; Commentary:
 
-;; Implementation notes
-;; --------------------
+;; This package provides fuzzy completion matching with good sorting.
+
+;; 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 with only lowercase characters
+;; so the sorting algorithm can do something smart.
+
+;;; Implementation notes
 ;;
 ;; Use defsubst instead of defun.
 ;;