diff --git a/doc/KDTree.rst b/doc/KDTree.rst index 2252819..5bb8a97 100644 --- a/doc/KDTree.rst +++ b/doc/KDTree.rst @@ -36,13 +36,17 @@ :arg buffer: A |buffer| containing a data point to match against. The number of frames in the buffer must match the dimensionality of the :fluid-obj:`DataSet` the tree was fitted to. - :arg k: The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest. + :arg k: (optional) The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest. + + :arg action: A function that will run when the query returns, whose argument is an array of distances. Returns the identifiers of the ``k`` points nearest to the one passed. :message kNearestDist: :arg buffer: A |buffer| containing a data point to match against. The number of frames in the buffer must match the dimensionality of the :fluid-obj:`DataSet` the tree was fitted to. + + :arg k: (optional) The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest. :arg action: A function that will run when the query returns, whose argument is an array of distances.