Skip to content

Commit

Permalink
Improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
juliohm committed Oct 15, 2024
1 parent 53f5788 commit 7927d04
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/empirical/algorithms.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
"""
AccumAlgorithm
Algorithm for accumulating pairs of points in the
estimation of geostatistical functions.
Algorithm used for accumulating values in
the estimation of geostatistical functions.
"""
abstract type AccumAlgorithm end

"""
accumulate(data, vars, estimator, algo)
Accumulate pairs of points in `data` for variables
`vars` with `estimator` and accumulation `algo`.
Accumulate values for pairs of variables `vars` stored
in `data` with `estimator` and accumulation `algo`.
"""
function accumulate(data, vars, estimator::Estimator, algo::AccumAlgorithm)
# retrieve algorithm parameters
Expand Down

0 comments on commit 7927d04

Please sign in to comment.