diff options
| author | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-02-01 18:06:32 +0300 |
|---|---|---|
| committer | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-02-01 20:16:12 +0300 |
| commit | baa8b63111f2ac5439155b6e0807a22f550b40f0 (patch) | |
| tree | a2ec98474d36bb21646f29ad6b61f3024fff0652 /source/blender/python/mathutils/mathutils.c | |
| parent | fd75796afe27186e0f651efde4ded2921bd3bb6e (diff) | |
Documentation: updated mathutils documentation
Added descriptions of the constructors, and improved the module-level
documentation.
Diffstat (limited to 'source/blender/python/mathutils/mathutils.c')
| -rw-r--r-- | source/blender/python/mathutils/mathutils.c | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/source/blender/python/mathutils/mathutils.c b/source/blender/python/mathutils/mathutils.c index ecaaae80aa2..ca20f837b4a 100644 --- a/source/blender/python/mathutils/mathutils.c +++ b/source/blender/python/mathutils/mathutils.c @@ -38,7 +38,18 @@ #endif PyDoc_STRVAR(M_Mathutils_doc, -"This module provides access to matrices, eulers, quaternions and vectors." +"This module provides access to the math classes:\n" +"\n" +"- :class:`Color`,\n" +"- :class:`Euler`,\n" +"- :class:`Matrix`,\n" +"- :class:`Quaternion`,\n" +"- :class:`Vector`,\n" +"\n" +".. note::\n" +"\n" +" Classes, methods and attributes that accept vectors also accept other numeric sequences,\n" +" such as tuples, lists." ); static int mathutils_array_parse_fast(float *array, int size, |