diff options
author | Bastien Montagne <montagne29@wanadoo.fr> | 2013-03-25 18:46:34 +0400 |
---|---|---|
committer | Bastien Montagne <montagne29@wanadoo.fr> | 2013-03-25 18:46:34 +0400 |
commit | 74e37ec0e608ce5f4b0f94a2b4dca156a935a0df (patch) | |
tree | c01171099f497fb4b3f44a0c4f9c5ad55cec24ba /source | |
parent | 4cb9414b397e49ca246c672bf79096cc192b24a8 (diff) |
Fix to EnumProperty doc (content of items tuples was rather fuzzy, ways how these "parameters" are interpreted are rather strange, current text should now reflect exactly code's behavior).
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/intern/bpy_props.c | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/source/blender/python/intern/bpy_props.c b/source/blender/python/intern/bpy_props.c index c330eb1549d..eef02285f3c 100644 --- a/source/blender/python/intern/bpy_props.c +++ b/source/blender/python/intern/bpy_props.c @@ -2527,13 +2527,16 @@ BPY_PROPDEF_DESC_DOC " :arg items: sequence of enum items formatted:\n" " [(identifier, name, description, icon, number), ...] where the identifier is used\n" " for python access and other values are used for the interface.\n" +" The three first elements of the tuples are mandatory.\n" +" The forth one is either the (unique!) number id of the item or, if followed by a fith element \n" +" (which must be the numid), an icon string identifier.\n" " Note the item is optional.\n" " For dynamic values a callback can be passed which returns a list in\n" " the same format as the static list.\n" " This function must take 2 arguments (self, context)\n" " WARNING: Do not use generators here (they will work the first time, but will lead to empty values\n" -" in some unload/reload scenarii)!\n" -" :type items: sequence of string triples or a function\n" +" in some unload/reload scenarii)!\n" +" :type items: sequence of string tuples or a function\n" BPY_PROPDEF_UPDATE_DOC ); static PyObject *BPy_EnumProperty(PyObject *self, PyObject *args, PyObject *kw) |