Add some docs

JuliaIO · Dec 6, 2023 · c55114f · c55114f
1 parent f5f04d1
commit c55114f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/docs/src/storage.md b/docs/src/storage.md
@@ -8,13 +8,10 @@ CurrentModule = Zarr
 
 ```@docs
 storagesize
-zname
+Zarr.zname
 Base.getindex(d::AbstractStore,i::String)
 Base.setindex!(d::AbstractStore,v,i::String)
-subdirs
-Base.keys(d::AbstractStore)
-newsub
-getsub
+Zarr.subdirs
 ```
 
 You can get some inspiration on how to implement this by looking at the source code of existing storage backends.
diff --git a/src/ZArray.jl b/src/ZArray.jl
@@ -53,6 +53,11 @@ function Base.show(io::IO,::MIME"text/plain",z::ZArray)
   print(io, "ZArray{", eltype(z) ,"} of size ",join(string.(size(z)), " x "))
 end
 
+"""
+    zname(z::ZArray)
+
+Extract the name of a Zarr array from the object
+"""
 zname(z::ZArray) = zname(path(z))
 
 function zname(s::String)