emacs-emojify

commit 26654085096b5cce4d89dae3ee69a6ff8cf765a6
parent 8b6eef7676e8aba3954cd37b96ac8a104033bc09
Author: Iqbal Ansari <iqbalansari02@yahoo.com>
Date:   Tue, 17 Nov 2020 21:20:15 +0530

Update the docstring of `emojify-completing-read` to mention new API for the predicate

Diffstat:
M
emojify.el
 | 
10
+++++-----

1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/emojify.el b/emojify.el
@@ -1824,16 +1824,16 @@ HIST, DEF, INHERIT-INPUT-METHOD correspond to the arguments for
 `emojify-completing-read-function' and are passed to
 ‘emojify-completing-read-function’ without any interpretation.
 
-For each possible emoji PREDICATE is called with emoji text and data about the
-emoji as a hash-table, the predate should return nil if it the emoji should
-not be displayed for selection.
+For each possible emoji PREDICATE is called with a string of the form
+'<emoji> - <name> (<style>)', the predicate should return nil if it the emoji should not be
+displayed for selection.
 
 For example the following can be used to display only github style emojis for
 selection
 
 \(emojify-completing-read \"Select a Github style emoji: \"
-                         (lambda (emoji data)
-                           (equal (gethash \"style\" data) \"github\")))
+                         (lambda (display-string)
+                           (s-suffix? display-string \"(github)\")))
 
 This function sets up `ido', `icicles', `helm', `ivy' and vanilla Emacs
 completion UI to display properly emojis."