Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/source
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2016-04-19 11:25:56 +0300
committerCampbell Barton <ideasman42@gmail.com>2016-04-19 11:25:56 +0300
commit376c8dd95ee2412d91292fe04ee3227d955a6e62 (patch)
tree95479ab298800c5037656b8ffb1a71765085eabe /source
parent7cc9f6b6f83df811f9236fd58499a19151687428 (diff)
Fix T48193: Incorrect keyframe_insert docs
Diffstat (limited to 'source')
-rw-r--r--source/blender/python/intern/bpy_rna_anim.c15
1 files changed, 8 insertions, 7 deletions
diff --git a/source/blender/python/intern/bpy_rna_anim.c b/source/blender/python/intern/bpy_rna_anim.c
index e74a5185ab0..2ec73c3c9b7 100644
--- a/source/blender/python/intern/bpy_rna_anim.c
+++ b/source/blender/python/intern/bpy_rna_anim.c
@@ -188,18 +188,19 @@ char pyrna_struct_keyframe_insert_doc[] =
"\n"
" :arg data_path: path to the property to key, analogous to the fcurve's data path.\n"
" :type data_path: string\n"
-" :arg index: array index of the property to key. Defaults to -1 which will key all indices or a single channel "
- "if the property is not an array.\n"
+" :arg index: array index of the property to key.\n"
+" Defaults to -1 which will key all indices or a single channel if the property is not an array.\n"
" :type index: int\n"
" :arg frame: The frame on which the keyframe is inserted, defaulting to the current frame.\n"
" :type frame: float\n"
" :arg group: The name of the group the F-Curve should be added to if it doesn't exist yet.\n"
" :type group: str\n"
-" :arg options: Some optional flags:\n"
-" 'NEEDED': Only insert keyframes where they're needed in the relevant F-Curves.\n"
-" 'VISUAL': Insert keyframes based on 'visual transforms'.\n"
-" 'XYZ_TO_RGB': Color for newly added transformation F-Curves (Location, Rotation, Scale) "
- "and also Color is based on the transform axis.\n"
+" :arg options: Optional flags:\n"
+"\n"
+" - ``INSERTKEY_NEEDED`` Only insert keyframes where they're needed in the relevant F-Curves.\n"
+" - ``INSERTKEY_VISUAL`` Insert keyframes based on 'visual transforms'.\n"
+" - ``INSERTKEY_XYZ_TO_RGB`` Color for newly added transformation F-Curves (Location, Rotation, Scale)\n"
+" and also Color is based on the transform axis.\n"
" :type flag: set\n"
" :return: Success of keyframe insertion.\n"
" :rtype: boolean\n"