Docstring and function rename

Author: CasBex

src/common/sum_tree.jl

@@ -131,7 +131,11 @@ function Base.empty!(t::SumTree)
     t
 end
 
-function correct_priority(t::SumTree, leaf_ind)
+"""
+    correct_sample(t::SumTree, leaf_ind)
+Check whether the sampled leaf is valid and if not return another valid leaf close to it. Used to correct samples with zero priority which may occur due to numerical errors with floats.
+"""
+function correct_sample(t::SumTree, leaf_ind)
     p = t.tree[leaf_ind]
     # walk backwards until p != 0 or until leftmost leaf reached
     tmp_ind = leaf_ind
@@ -170,7 +174,7 @@ function Base.get(t::SumTree, v)
     if leaf_ind <= t.nparents
         leaf_ind += t.capacity
     end
-    p, leaf_ind = correct_priority(t, leaf_ind)
+    p, leaf_ind = correct_sample(t, leaf_ind)
     ind = leaf_ind - t.nparents
     real_ind = ind >= t.first ? ind - t.first + 1 : ind + t.capacity - t.first + 1
     real_ind, p
@@ -190,4 +194,4 @@ function Random.rand(rng::AbstractRNG, t::SumTree{T}, n::Int) where {T}
     inds, priorities
 end
 
-Random.rand(t::SumTree, n::Int) = rand(Random.GLOBAL_RNG, t, n)
+Random.rand(t::SumTree, n::Int) = rand(Random.GLOBAL_RNG, t, n)