[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia 77b8e568d8: README update, de-emphasize priv
From: |
ELPA Syncer |
Subject: |
[elpa] externals/marginalia 77b8e568d8: README update, de-emphasize private APIs |
Date: |
Tue, 23 Jul 2024 18:58:27 -0400 (EDT) |
branch: externals/marginalia
commit 77b8e568d8e14090ee40d9549fd727a62eb82f7d
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README update, de-emphasize private APIs
---
README.org | 17 +++++++----------
1 file changed, 7 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index c249fccf17..4f0ec6220b 100644
--- a/README.org
+++ b/README.org
@@ -76,12 +76,13 @@ 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]]. 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.
+=: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.
Commands that support minibuffer completion use a completion table of all the
available candidates. Candidates are associated with a *category* such as
=command=,
@@ -131,10 +132,6 @@ Here's an example of a basic face annotator:
(propertize "The quick brown fox jumps over the lazy dog" 'face
sym))))
#+end_src
-Look at Marginalia's various annotators for examples of formatting annotations.
-In particular, the helper function =marginalia--fields= can be used to format
-information into columns.
-
After defining a new annotator, associate it with a category in the annotator
registry as follows:
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/marginalia 77b8e568d8: README update, de-emphasize private APIs,
ELPA Syncer <=