PyDocs: Adde link to Wikipedia page for mathutils.Euler class
authorAaron Carlisle <carlisle.b3d@gmail.com>
Thu, 29 Mar 2018 18:25:13 +0000 (14:25 -0400)
committerAaron Carlisle <carlisle.b3d@gmail.com>
Thu, 29 Mar 2018 18:25:13 +0000 (14:25 -0400)
This update adds a link to the Wikipedia article "Euler angles" to the description of the mathutils.Euler class.
I initially was not sure what a "Euler" represented in Blender API, but found the Wikipedia article helpful. I believe others will find the link helpful too if it appears in the class documentation.

This is similar to the Wikipedia links that appear in the mathutils.Matrix class, e.g: https://docs.blender.org/api/blender_python_api_current/mathutils.html?highlight=euler#mathutils.Matrix.adjugate

Author: @justasb

Reviewers: campbellbarton, trumanblending, Blendify

Reviewed By: Blendify

Subscribers: Blendify

Tags: #bf_blender

Differential Revision: https://developer.blender.org/D3077

source/blender/python/mathutils/mathutils_Euler.c

index 9492b6d67f3dcd4bb15bffa1a929d7c89088bba9..026384743bd7fe3650121da483e355db41f51f5e 100644 (file)
@@ -689,6 +689,8 @@ PyDoc_STRVAR(euler_doc,
 "\n"
 "   This object gives access to Eulers in Blender.\n"
 "\n"
+"   .. seealso:: `Euler angles <https://en.wikipedia.org/wiki/Euler_angles>`__ on Wikipedia.\n"
+"\n"
 "   :param angles: Three angles, in radians.\n"
 "   :type angles: 3d vector\n"
 "   :param order: Optional order of the angles, a permutation of ``XYZ``.\n"