[mlpack] 04/324: Fix comment and clarify that it's pertaining to the runtime constructor, not the template parameters.

[Barak A. Pearlmutter]

This is an automated email from the git hooks/post-receive script.

bap pushed a commit to branch svn-trunk
in repository mlpack.

commit fad2e2ea01426961517d4c177e0f95ae9b5e4bcc
Author: rcurtin <rcurtin at 9d5b8971-822b-0410-80eb-d18c1038ef23>
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.
    
    
    git-svn-id: http://svn.cc.gatech.edu/fastlab/mlpack/trunk@16522 9d5b8971-822b-0410-80eb-d18c1038ef23
---
 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/.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/mlpack.git