Updated doc for src/datastore.jl

src/datastore.jl

@@ -6,6 +6,12 @@ else
     import Distributed: ClusterSerializer, worker_id_from_socket
 end
 
+"""
+    DRef(owner::Int, id::Int, size::UInt)
+
+A Distributed Reference (DRef)  which acts as a handle to store data in MemPool.
+It tracks which worker 'owner' holds the data and a unique 'id' assigned to the data
+"""
 mutable struct DRef
     owner::Int
     id::Int
@@ -451,6 +457,12 @@ function ensure_memory_reserved(size::Integer=0; max_sweeps::Integer=MEM_RESERVE
     end
 end
 
+"""
+    poolset(x, [pid]; kwargs...) -> DRef
+
+Stores the value 'x' into the memory pool on worker 'pid' (defaults to myid())
+and returns a 'DRef' handle
+"""
 function poolset(@nospecialize(x), pid=myid(); size=approx_size(x),
                  retain=false, restore=false,
                  device=GLOBAL_DEVICE[], leaf_device=initial_leaf_device(device),
@@ -523,6 +535,12 @@ function forwardkeyerror(f)
     end
 end
 
+"""
+    poolget(ref::Dref)
+
+Retrieves the data value referenced by 'ref'. If the data is remote or 
+on disk, MemPool handles the retrieval automatically
+"""
 function poolget(ref::DRef)
     DEBUG_REFCOUNTING[] && _enqueue_work(Core.print, "?? (", ref.owner, ", ", ref.id, ") at ", myid(), "\n")
     return access_ref(identity, ref)