Clarify nearest_neighbors() method

[JosiahParry]

rstar/rstar/src/rtree.rs

Line 681 in 0ed7748

/// All returned values will have the exact same distance from the given query point.

The nearest_neighbors() method seems like it can be usefull for KNN however it is not immediately clear in the docs how it works. Does it return a vector of all neighboring points sorted by distance?

Can this method be clarified further?

[adamreichold]

I think you are looking for nearest_neighbor_iter. nearest_neighbors is meant only for when there is no single nearest neighbour but multiple objects have exactly the same distance as quoted from the documentation.

[JosiahParry]

Thanks for the response @adamreichold! That might be what I need. I still think the documentation can be improved, howevre.