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...
This commit is contained in:
Bastien Montagne 2015-02-20 10:54:26 +01:00
parent 185e301229
commit 51b0ae8a85
Notes: blender-bot 2023-02-14 09:28:25 +01:00
Referenced by issue #43739, "bmesh.geometry.intersect_face_point" does not always return the correct information
1 changed files with 2 additions and 2 deletions

View File

@ -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)