branch: master
commit c05b6619b6a522f012b3a93d7a95aebdb2093060
Author: Ian Dunn <[email protected]>
Commit: Ian Dunn <[email protected]>
Added documentation about using a timeout for cache
---
org-edna.el | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/org-edna.el b/org-edna.el
index 5a152e6..37c9849 100644
--- a/org-edna.el
+++ b/org-edna.el
@@ -469,6 +469,11 @@ which of the two types is allowed in STRING-FORM."
;; Cache works because the returned values of finders are all markers. Markers
;; will automatically update themselves when a buffer is edited.
+;; We use a timeout for cache because it's expected that the Org files
+;; themselves will change. Thus, there's no assured way to determine if we
need
+;; to update the cache without actually running again. Therefore, we assume
+;; most operations that the user wants to expedite will be performed in bulk.
+
(cl-defstruct org-edna--finder-input
func-sym args)
