Add more docs to FolderDict (#1010)

JuliaRobotics · Apr 24, 2024 · 2fc5395 · 2fc5395
1 parent 3ce65f7
commit 2fc5395
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/dev/FolderDict.jl b/src/dev/FolderDict.jl
@@ -24,8 +24,9 @@ Special Features:
 - EXPERIMENTAL: thread safe
 
 Developer Notes
-- all keys must always be in `.keydict`, regardless of cache or priority
-- pqueue is arbitor, so assumed that .cache will mirror happenings of pqueue
+- all keys must always be in `.keydict`, regardless of cache or priority.
+- all setindex! call always writes the elemental to folder regardless of caching.
+- pqueue is arbitor, so assumed that .cache will mirror happenings of pqueue.
 
 WIP Constraints:
 - FIXME, had trouble inheriting from `Base.AbstractDict`