[Bf-blender-cvs] [1d409defbf3] master: Docs: clarify return value for BVH API

[Campbell Barton]

Commit: 1d409defbf3fd40b9291c4945975cc36e355ddc0
Author: Campbell Barton
Date:   Fri Oct 27 16:14:24 2017 +1100
Branches: master
https://developer.blender.org/rB1d409defbf3fd40b9291c4945975cc36e355ddc0

Docs: clarify return value for BVH API

===================================================================

M	source/blender/python/mathutils/mathutils_bvhtree.c

===================================================================

diff --git a/source/blender/python/mathutils/mathutils_bvhtree.c b/source/blender/python/mathutils/mathutils_bvhtree.c
index e1b414d9ba1..22e7bf3dd27 100644
--- a/source/blender/python/mathutils/mathutils_bvhtree.c
+++ b/source/blender/python/mathutils/mathutils_bvhtree.c
@@ -391,7 +391,7 @@ static PyObject *py_bvhtree_ray_cast(PyBVHTree *self, PyObject *args)
 PyDoc_STRVAR(py_bvhtree_find_nearest_doc,
 ".. method:: find_nearest(origin, distance=" PYBVH_MAX_DIST_STR ")\n"
 "\n"
-"   Find the nearest element to a point.\n"
+"   Find the nearest element (typically face index) to a point.\n"
 "\n"
 "   :arg co: Find nearest element to this point.\n"
 "   :type co: :class:`Vector`\n"
@@ -476,7 +476,7 @@ static void py_bvhtree_nearest_point_range_cb(void *userdata, int index, const f
 PyDoc_STRVAR(py_bvhtree_find_nearest_range_doc,
 ".. method:: find_nearest_range(origin, distance=" PYBVH_MAX_DIST_STR ")\n"
 "\n"
-"   Find the nearest elements to a point in the distance range.\n"
+"   Find the nearest elements (typically face index) to a point in the distance range.\n"
 "\n"
 "   :arg co: Find nearest elements to this point.\n"
 "   :type co: :class:`Vector`\n"