[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/marginalia 78023eb 038/241: update readme
From: |
Stefan Monnier |
Subject: |
[elpa] externals/marginalia 78023eb 038/241: update readme |
Date: |
Fri, 28 May 2021 20:48:52 -0400 (EDT) |
branch: externals/marginalia
commit 78023eba0f733ff1d377ba7f8f4e2f04166608a8
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
update readme
---
README.md | 14 ++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 71aad71..61f4c7e 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@ annotations placed at the margin of the page of a book or in
this case helpful
colorful annotations placed at the margin of the minibuffer for your completion
candidates. The annotations are added based on the completion category. For
example `find-file` reports the `file` category and `M-x` reports the `command`
-category.
+category. You can choose between more or less detailed annotators, by
+setting the variable `marginalia-annotators`.
Since many commands do not report a completion category themselves, Marginalia
provides a classifier system, which tries to guess the correct category based
@@ -31,11 +32,8 @@ specified by the variable `marginalia-classifiers`.
;; enabled right away. Note that this forces loading the package.
(marginalia-mode)
- ;; Enable richer annotations for M-x.
- ;; Only keybindings are shown by default, in order to reduce noise for this
very common command.
- ;; * marginalia-annotate-symbol: Annotate with the documentation string
- ;; * marginalia-annotate-command-binding (default): Annotate only with the
keybinding
- ;; * marginalia-annotate-command-full: Annotate with the keybinding and the
documentation string
- ;; (setf (alist-get 'command marginalia-annotators)
#'marginalia-annotate-command-full)
-)
+ ;; Enable richer, more heavy, annotations.
+ ;; E.g. M-x will show the documentation string additional to the keybinding.
+ ;; By default only the keybinding is shown as annotation.
+ (setq marginalia-annotators 'marginalia-annotators-heavy))
~~~
- [elpa] externals/marginalia cf9f411 125/241: marginalia: always run annotators in the original window context, (continued)
- [elpa] externals/marginalia cf9f411 125/241: marginalia: always run annotators in the original window context, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia c574a26 054/241: more colors!, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 2b85b73 130/241: fix marginalia--full-candidate, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 3ec73cd 138/241: Merry Christmas, MELPA!, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 5129917 150/241: fix readme, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 2f849d8 013/241: Simplify marginalia--completion-metadata-get, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia c97911b 021/241: All classifiers from Embark have been imported, remove TODO, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 0cb98a0 023/241: Remove default value from prompt before matching, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 7fe8f71 027/241: improve buffer annotation formatting, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4ba9804 031/241: Fix bug: file annotations were only shown for current directory, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 78023eb 038/241: update readme,
Stefan Monnier <=
- [elpa] externals/marginalia b6d2e22 037/241: fix typo, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 472b47a 041/241: add comment to marginalia-toggle-annotators, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 85a2693 053/241: marginalia-annotate-package: show package archive, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia dfbaa7f 061/241: marginalia-annotate-package: show installed status instead of archive, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 17d539c 059/241: whitespace and comment adjustments, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 4a5ada6 063/241: smaller variable field, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 2f1bb7c 064/241: do not overwrite the face weights as per recommendation by @purcell, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 785297d 075/241: Indicate advised functions with an asterisk, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia 0bd8061 077/241: marginalia--fields: allow alignment to the right by using a negative width, Stefan Monnier, 2021/05/28
- [elpa] externals/marginalia f16d26a 082/241: marginalia-annotate-symbol: add keybindings to commands, Stefan Monnier, 2021/05/28