From 069e68717cd601a8690dd2094130c37bf4a56889 Mon Sep 17 00:00:00 2001
From: rafaqz <rafaelschouten@gmail.com>
Date: Fri, 2 Feb 2024 15:47:50 +0100
Subject: [PATCH] document

---
 src/cached.jl | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/cached.jl b/src/cached.jl
index cb893bf..3bdec2f 100644
--- 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