Skip to content

Commit 20feced

Browse files
juliohmsouma4
authored andcommitted
Improve docstring of BallSearch and KBallSearch
1 parent 1bdff3b commit 20feced

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/neighborsearch/ball.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
"""
66
BallSearch(domain, ball)
77
8-
A method for searching neighbors in `domain` inside `ball`.
8+
A method for searching neighbors in `domain` inside metric `ball`.
9+
10+
See [`MetricBall`](@ref) for additional details.
911
"""
1012
struct BallSearch{D<:Domain,B<:MetricBall,T} <: NeighborSearchMethod
1113
# input fields

src/neighborsearch/kball.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
KBallSearch(domain, k, ball)
77
88
A method that searches `k` nearest neighbors and then filters
9-
these neighbors using a norm `ball`.
9+
these neighbors using a metric `ball`.
10+
11+
See [`MetricBall`](@ref) for additional details.
1012
"""
1113
struct KBallSearch{D<:Domain,B<:MetricBall,T} <: BoundedNeighborSearchMethod
1214
# input fields

0 commit comments

Comments
 (0)