diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-03-06 10:50:58 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-03-06 11:02:57 +0300 |
commit | f682129d62f0c43b0ff0027848c1825853674268 (patch) | |
tree | e7a296b8dea118cc8744ccaf3597426d6465510b /source | |
parent | 8638142c3bf1d0701a08d3222366fcd92d3e7772 (diff) |
PyAPI: clarify fallback docstring
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/mathutils/mathutils_Matrix.c | 4 | ||||
-rw-r--r-- | source/blender/python/mathutils/mathutils_Vector.c | 16 |
2 files changed, 8 insertions, 12 deletions
diff --git a/source/blender/python/mathutils/mathutils_Matrix.c b/source/blender/python/mathutils/mathutils_Matrix.c index d4ed859fd5c..67905f8e340 100644 --- a/source/blender/python/mathutils/mathutils_Matrix.c +++ b/source/blender/python/mathutils/mathutils_Matrix.c @@ -1438,8 +1438,8 @@ PyDoc_STRVAR(Matrix_inverted_doc, "\n" " Return an inverted copy of the matrix.\n" "\n" -" :arg fallback: return this value when the inverse can't be calculated\n" -" (instead of raising a :exc:`ValueError` exception).\n" +" :arg fallback: return this when the inverse can't be calculated\n" +" (instead of raising a :exc:`ValueError`).\n" " :type fallback: any\n" " :return: the inverted matrix or fallback when given.\n" " :rtype: :class:`Matrix`\n" diff --git a/source/blender/python/mathutils/mathutils_Vector.c b/source/blender/python/mathutils/mathutils_Vector.c index 5cb7d71d52c..a33b55c35dc 100644 --- a/source/blender/python/mathutils/mathutils_Vector.c +++ b/source/blender/python/mathutils/mathutils_Vector.c @@ -957,13 +957,11 @@ PyDoc_STRVAR(Vector_angle_doc, "\n" " :arg other: another vector to compare the angle with\n" " :type other: :class:`Vector`\n" -" :arg fallback: return this value when the angle can't be calculated\n" -" (zero length vector)\n" +" :arg fallback: return this when the angle can't be calculated (zero length vector),\n" +" (instead of raising a :exc:`ValueError`).\n" " :type fallback: any\n" " :return: angle in radians or fallback when given\n" " :rtype: float\n" -"\n" -" .. note:: Zero length vectors raise an :exc:`ValueError`.\n" ); static PyObject *Vector_angle(VectorObject *self, PyObject *args) { @@ -1021,13 +1019,11 @@ PyDoc_STRVAR(Vector_angle_signed_doc, "\n" " :arg other: another vector to compare the angle with\n" " :type other: :class:`Vector`\n" -" :arg fallback: return this value when the angle can't be calculated\n" -" (zero length vector)\n" +" :arg fallback: return this when the angle can't be calculated (zero length vector),\n" +" (instead of raising a :exc:`ValueError`).\n" " :type fallback: any\n" " :return: angle in radians or fallback when given\n" " :rtype: float\n" -"\n" -" .. note:: Zero length vectors raise an :exc:`ValueError`.\n" ); static PyObject *Vector_angle_signed(VectorObject *self, PyObject *args) { @@ -1195,8 +1191,8 @@ PyDoc_STRVAR(Vector_slerp_doc, " :type other: :class:`Vector`\n" " :arg factor: The interpolation value typically in [0.0, 1.0].\n" " :type factor: float\n" -" :arg fallback: return this value when the vector can't be calculated\n" -" (zero length vector or direct opposites)\n" +" :arg fallback: return this when the vector can't be calculated (zero length vector or direct opposites),\n" +" (instead of raising a :exc:`ValueError`).\n" " :type fallback: any\n" " :return: The interpolated vector.\n" " :rtype: :class:`Vector`\n" |