document

JuliaIO · Feb 2, 2024 · 069e687 · 069e687
1 parent 88513af
commit 069e687
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/cached.jl b/src/cached.jl
@@ -3,6 +3,15 @@
 # This is useful in `zip` and other operations that can iterate
 # over multiple arrays with different patterns.
 
+"""
+    CachedDiskArray <: AbstractDiskArray
+
+    CachedDiskArray(A::AbstractArray; maxsize=1000)
+
+Wrap some disk array `A` with a caching mechanism that will 
+keep chunks up to a total of `maxsize` megabytes, dropping
+the least used chunks when `maxsize` is exceeded.
+"""
 struct CachedDiskArray{T,N,A<:AbstractArray{T,N},C} <: AbstractDiskArray{T,N}
     parent::A
     cache::C