branch: externals/marginalia
commit d3773f8dc74a883032dccf1c7e20bed1acf2016c
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
README adjustments
---
README.org | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index cbd1c03..7061824 100644
--- a/README.org
+++ b/README.org
@@ -55,14 +55,15 @@ commands.
(marginalia-mode))
#+end_src
-* Usage
-The annotations for elisp symbols include their symbol class. For more
-information on what the different classifications mean, see the docstring of
-~marginalia--symbol-class~.
+* Information shown by the annotators
In general, to learn more about what different annotations mean, a good
starting
point is to look at ~marginalia-annotator-registry~, and follow up to the
-annotation function of whatever category you are interested in.
+annotation function of the category you are interested in.
+
+For example the annotations for elisp symbols include their symbol class - v
for
+variable, f for function, c for command, etc. For more information on what the
+different classifications mean, see the docstring of
~marginalia--symbol-class~.
* Adding custom annotators or classifiers
