From 11f0fbe557a10f970470d21f5ebb0f423fe3f023 Mon Sep 17 00:00:00 2001 From: Bruce D'Arcus Date: Mon, 4 Jul 2022 05:00:23 -0400 Subject: [PATCH] README tweaks --- README.org | 6 +++--- citar.el | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.org b/README.org index 2d632965..98693dd2 100644 --- a/README.org +++ b/README.org @@ -225,15 +225,15 @@ You can save this history across sessions by adding =citar-history= to =savehist Citar uses a cache to speed up library display. If a bib file changes, the cache will automatically update the next time you run a Citar command. - -The =citar-cache-refresh= command will also reload the caches manually. +Note that cached data preformatted completion candidates are independently tracked by file. +So, for example, if you have one very large bibliography file that changes a lot, you might consider splitting into one large file that is more stable, and one-or-more smaller ones that change more frequently. ** Notes Citar offers configurable note-taking and access integration. The ~citar-notes-sources~ variable configures note backends, and ~citar-notes-source~ activates your chosen backend. A backend primarily specifies functions to update the Citar display, to create the completion candidates, and to open existing and new notes. -See the docstrings for details. +See the ~citar-notes-sources~ docstring for details, and the =citar-register-note-source= and =citar-remove-note-source= convenience functions. ** Files, file association and file-field parsing diff --git a/citar.el b/citar.el index 09f02989..f6906f58 100644 --- a/citar.el +++ b/citar.el @@ -513,8 +513,8 @@ FILTER: if non-nil, should be a predicate function taking (cl-defun citar-select-ref (&key filter) "Select bibliographic references. -Call `citar-select-ref' with argument `:multiple'; see its -documentation for the return value." +Call 'citar-select-ref' with argument ':multiple, and optional +FILTER; see its documentation for the return value." (car (citar-select-refs :multiple nil :filter filter))) (defun citar--multiple-completion-table (selected-hash candidates filter)