[mlpack-git] master: Update documentation to fix #672. (da7a2c0)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/5b8fdce471328f722fcd8c0f22a6d995ce22c98b...da7a2c03069d4ff6ef89c1b0d445e8192d76cc14

>---------------------------------------------------------------

commit da7a2c03069d4ff6ef89c1b0d445e8192d76cc14
Author: Ryan Curtin <ryan at ratml.org>
Date:   Sun Jun 5 14:29:43 2016 -0400

    Update documentation to fix #672.


>---------------------------------------------------------------

da7a2c03069d4ff6ef89c1b0d445e8192d76cc14
 src/mlpack/methods/neighbor_search/neighbor_search.hpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/mlpack/methods/neighbor_search/neighbor_search.hpp b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
index ce05308..e84b74c 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
@@ -219,6 +219,11 @@ class NeighborSearch
    * number of points in the query dataset and k is the number of neighbors
    * being searched for.
    *
+   * Note that if you are calling Search() multiple times with a single query
+   * tree, you need to reset the bounds in the statistic of each query node,
+   * otherwise the result may be wrong!  You can do this by calling
+   * TreeType::Stat()::Reset() on each node in the query tree.
+   *
    * @param queryTree Tree built on query points.
    * @param k Number of neighbors to search for.
    * @param neighbors Matrix storing lists of neighbors for each query point.