[Bf-blender-cvs] [51b0ae8] master: Fix T43739: bad documentation for bmesh py `intersect_face_point()`

Bastien Montagne noreply at git.blender.org
Fri Feb 20 10:56:16 CET 2015


Commit: 51b0ae8a85dbb47963f24fe3d79de878092cc6cc
Author: Bastien Montagne
Date:   Fri Feb 20 10:54:26 2015 +0100
Branches: master
https://developer.blender.org/rB51b0ae8a85dbb47963f24fe3d79de878092cc6cc

Fix T43739: bad documentation for bmesh py `intersect_face_point()`

Previous text could make think this func was checking whether a point was
inside and on the face, while it actually checks whether the projection
of that point onto the face is inside its boundary...

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

M	source/blender/python/bmesh/bmesh_py_geometry.c

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

diff --git a/source/blender/python/bmesh/bmesh_py_geometry.c b/source/blender/python/bmesh/bmesh_py_geometry.c
index a48a9da..f67bf29 100644
--- a/source/blender/python/bmesh/bmesh_py_geometry.c
+++ b/source/blender/python/bmesh/bmesh_py_geometry.c
@@ -43,13 +43,13 @@
 PyDoc_STRVAR(bpy_bm_geometry_intersect_face_point_doc,
 ".. method:: intersect_face_point(face, point)\n"
 "\n"
-"   Tests if a point is inside a face (using the faces normal).\n"
+"   Tests if the projection of a point is inside a face (using the face's normal).\n"
 "\n"
 "   :arg face: The face to test.\n"
 "   :type face: :class:`bmesh.types.BMFace`\n"
 "   :arg point: The point to test.\n"
 "   :type point: float triplet\n"
-"   :return: True when the point is in the face.\n"
+"   :return: True when the projection of the point is in the face.\n"
 "   :rtype: bool\n"
 );
 static PyObject *bpy_bm_geometry_intersect_face_point(BPy_BMFace *UNUSED(self), PyObject *args)




More information about the Bf-blender-cvs mailing list