[mlpack-git] master, mlpack-1.0.x: Fix comment and clarify that it's pertaining to the runtime constructor, not the template parameters. (482e443)

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

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

On branches: master,mlpack-1.0.x
Link       : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40

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

commit 482e443d3a5c9dbf87ec995eb5110b5ba28f8496
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon May 19 17:41:42 2014 +0000

    Fix comment and clarify that it's pertaining to the runtime constructor, not the
    template parameters.


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

482e443d3a5c9dbf87ec995eb5110b5ba28f8496
 src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp b/src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp
index 6b38b6f..6d83a65 100644
--- a/src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp
+++ b/src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp
@@ -24,6 +24,9 @@ namespace tree /** Trees and tree-building procedures. */ {
  * from it.  If you need to add or delete a node, the better procedure is to
  * rebuild the tree entirely.
  *
+ * This tree does take one runtime parameter in the constructor, which is the
+ * leaf size to be used.
+ *
  * @tparam BoundType The bound used for each node.  The valid types of bounds
  *     and the necessary skeleton interface for this class can be found in
  *     bounds/.