[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia ce8db0acf7: Update readme
From: |
ELPA Syncer |
Subject: |
[elpa] externals/marginalia ce8db0acf7: Update readme |
Date: |
Mon, 14 Nov 2022 15:58:05 -0500 (EST) |
branch: externals/marginalia
commit ce8db0acf7e81b78cb47d6cbb234ef93f2cbb822
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Update readme
---
README.org | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.org b/README.org
index c53c5ed582..dfb46b35bd 100644
--- a/README.org
+++ b/README.org
@@ -67,18 +67,19 @@ different classifications mean, see the docstring of
~marginalia--symbol-class~.
*IMPORTANT NOTICE FOR PACKAGE AUTHORS*: The intention of the Marginalia
package is
to give the user means to overwrite completion categories and to add custom
-annotators for existing commands in their user configuration. Marginalia is a
-user facing package and is not intended to be used as a library. Therefore
+annotators for existing commands in their user configuration. *Marginalia is a
+user facing package and is not intended to be used as a library*. Therefore
Marginalia does not expose library functions as part of its public API. If you
add your own completion commands to your package we recommend to specify an
=annotation-function= or an =affixation-function=, avoiding the Marginalia
dependency this way. The =annotation-function= and =affixation-function= are
-documented in the
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion.html][Elisp
manual]]. There is an exception to our recommendation: If
-you want to implement annotations for an existing package =hypothetic.el=,
which
-does not have annotations and where annotations cannot be added, then the
-creation of a =marginalia-hypothetic.el= package is a good idea, since
Marginalia
-provides the facilities to enhance existing commands from the outside. If you
-have questions feel free to ask on the Marginalia issue tracker!
+documented in the
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion.html][Elisp
manual]]. If you use =consult--read=, you can specify an
+=:annotate= keyword argument. There is an exception to our recommendation: If
you
+want to implement annotations for an existing package =hypothetic.el=, which
does
+not have annotations and where annotations cannot be added, then the creation
of
+a =marginalia-hypothetic.el= package is a good idea, since Marginalia provides
the
+facilities to enhance existing commands from the outside. If you have questions
+feel free to ask on the Marginalia issue tracker.
Commands that support minibuffer completion use a completion table of all the
available candidates. Candidates are associated with a *category* such as
=command=,
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/marginalia ce8db0acf7: Update readme,
ELPA Syncer <=