[mlpack-git] master: Update documentation. (742e8f2)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/f86acf8be2c01568d8b3dcd2e529ee9f20f7585e...156787dd4f372a7fd740f733127ac200ea2564b7

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

commit 742e8f23d775b3f7725e01c019bc3af77c601f08
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Nov 2 13:30:58 2015 +0000

    Update documentation.


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

742e8f23d775b3f7725e01c019bc3af77c601f08
 src/mlpack/methods/neighbor_search/neighbor_search.hpp | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/mlpack/methods/neighbor_search/neighbor_search.hpp b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
index f1865a7..1c74393 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
@@ -100,7 +100,7 @@ class NeighborSearch
    *
    * This method will not copy the data matrix, but will take ownership of it,
    * and depending on the type of tree used, may rearrange the points.  If you
-   * would rather a copy be made, consider using the construct that takes a
+   * would rather a copy be made, consider using the constructor that takes a
    * const reference to the data instead.
    *
    * @param referenceSet Set of reference points.
@@ -128,10 +128,10 @@ class NeighborSearch
    * copies absolutely must be avoided.
    *
    * @note
-   * Because tree-building (at least with BinarySpaceTree) modifies the ordering
-   * of a matrix, be sure you pass the modified matrix to this object!  In
-   * addition, mapping the points of the matrix back to their original indices
-   * is not done when this constructor is used.
+   * Mapping the points of the matrix back to their original indices is not done
+   * when this constructor is used, so if the tree type you are using maps
+   * points (like BinarySpaceTree), then you will have to perform the re-mapping
+   * manually.
    * @endnote
    *
    * @param referenceTree Pre-built tree for reference points.