From 31fbb254c46fc642a205042c620b5b41cae44633 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Omar=20Antol=C3=ADn?= Date: Thu, 16 Apr 2020 11:42:38 -0500 Subject: Update badly outdated commentary --- orderless.el | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/orderless.el b/orderless.el index c2c6237..b77a0dc 100644 --- a/orderless.el +++ b/orderless.el @@ -23,25 +23,25 @@ ;;; Commentary: -;; Warning: this package is experminental! -;; ;; This package provides an `orderless' completion style that divides -;; the pattern into space-separated chunks, treats each on as a -;; regexp, and matches canidates that match all of the regexps in any -;; order. +;; the pattern into components chunks (space-separated by default), +;; treats each on as a regexp, and matches candidates that match all of +;; the regexps in any order. ;; ;; Completion styles are used as entries in the variables ;; `completion-styles' and `completion-category-overrides', see their ;; documentation. ;; -;; By default the space key is bound to `minibuffer-complete-word' in -;; `minibuffer-local-map', which isn't useful with this completion -;; method. So, if you use it, you should also unbind SPC. -;; -;; So to test this completion you can use the following configuration: +;; To use this completion style you can use the following minimal +;; configuration: ;; ;; (setq completion-styles '(orderless)) -;; (define-key minibuffer-local-map (kbd "SPC") #'self-insert-command) +;; +;; You can customize the `orderless-regexp-separator' to decide how +;; the input pattern is split into component regexps. The default +;; splits on spaces. You might want to add hyphens and slashes, for +;; example, to ease completion of symbols and file paths, +;; respectively. ;;; Code: -- cgit v1.0