[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia b266842 2/2: README: Updates
From: |
ELPA Syncer |
Subject: |
[elpa] externals/marginalia b266842 2/2: README: Updates |
Date: |
Wed, 28 Jul 2021 06:57:17 -0400 (EDT) |
branch: externals/marginalia
commit b266842ce1fb1539c024e2fefff9189f38621c5c
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Updates
---
README.org | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index c8e54f7..5c2d283 100644
--- a/README.org
+++ b/README.org
@@ -26,9 +26,9 @@ appearance of the candidates themselves, which are shown as
supplied by
the original commands.
The annotations are added based on the completion category. For example
-=find-file= reports the =file= category and =M-x= reports the =command=
-category. You can cycle between more or less detailed annotators with the
-command =marginalia-cycle=.
+=find-file= reports the =file= category and =M-x= reports the =command=
category. You
+can cycle between more or less detailed annotators or even disable the
annotator
+with command =marginalia-cycle=.
#+html: <img
src="https://github.com/minad/marginalia/blob/main/marginalia-mode.png?raw=true">
@@ -55,12 +55,6 @@ commands.
(marginalia-mode))
#+end_src
-Marginalia shows a large number of annotations by default. To customize which
annotations show, the user can modify the content of the
`marginalia-annotator-registry` association list. For instance, if the user
does not want file listings annotated with file modes, sizes, and modification
times, they can disable the relevant `file` annotator:
-
-#+begin_src emacs-lisp
- (assq-delete-all 'file marginalia-annotator-registry)
-#+end_src
-
* Adding custom annotators or classifiers
Minibuffer completion commands can specify the type of the candidates which are
@@ -118,7 +112,7 @@ the =builtin= annotator as defined by Emacs and the =none=
annotator, which
disables the annotations. You can cycle between all of those annotators using
=marginalia-cycle= after invoking =M-x describe-face RET=.
-* Using builtin or lightweight annotators
+* Disabling annotators, builtin or lightweight annotators
Marginalia activates rich annotators by default. Depending on your preference
you may want to use the builtin annotators or even no annotators by default and
@@ -162,6 +156,15 @@ configuration. This can be achieved using an advice which
calls
marginalia-annotator-registry))))
#+end_src
+In order to disable an annotator permanently, the
~marginalia-annotator-registry~
+can be modified. For example if you prefer to never see file annotations, you
+can delete all file annotators from the registry.
+
+#+begin_src emacs-lisp
+ (setq marginalia-annotator-registry
+ (assq-delete-all 'file marginalia-annotator-registry))
+#+end_src
+
* Contributions
Since this package is part of
[[http://elpa.gnu.org/packages/marginalia.html][GNU ELPA]] contributions
require a copyright