diff options
author | Stephen Swaney <sswaney@centurytel.net> | 2004-05-25 23:59:41 +0400 |
---|---|---|
committer | Stephen Swaney <sswaney@centurytel.net> | 2004-05-25 23:59:41 +0400 |
commit | 05e76c22b08cd2844b25d9c45b25581da78ee7c9 (patch) | |
tree | 91db6e521a26e8b88dbcb55cb044f24eaee9230c /source | |
parent | 5e3a9c092acff0a22db26585c9ccaf77833eb60c (diff) |
bugfix: #1322 minor tweaks to the documentation for Draw module.
Blender.Draw.Button() was not showing up. Seems to be an epydoc
issue with Button() being both a module method and the name of a class.
I changed Button to Button_ and added a usage note.
Yes, this is lame.
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/api2_2x/doc/Draw.py | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/source/blender/python/api2_2x/doc/Draw.py b/source/blender/python/api2_2x/doc/Draw.py index 0a7b566c273..22381e069a5 100644 --- a/source/blender/python/api2_2x/doc/Draw.py +++ b/source/blender/python/api2_2x/doc/Draw.py @@ -124,9 +124,11 @@ def Create(value): @return: The Button created. """ -def Button(name, event, x, y, width, height, tooltip = None): +def Button_(name, event, x, y, width, height, tooltip = None): """ - Create a new (push) Button object. + Create a new (push) Button object. Please note there is no '_' character at the end of 'Button'. + This is due to a bug in our doc generation program. Use Button(....) instead. + And stop laughing. @type name: string @param name: The string to display on the button. @type event: int @@ -363,8 +365,7 @@ def Scrollbar(event, x, y, width, height, initial, min, max, realtime = 1, @return: The Button created. """ -def Number(name, event, x, y, width, height, initial, min, max, realtime = 1, - tooltip = None): +def Number(name, event, x, y, width, height, initial, min, max, tooltip = None): """ Create a new Number Button object. @type name: string @@ -386,9 +387,6 @@ def Number(name, event, x, y, width, height, initial, min, max, realtime = 1, @param initial: The initial value. @param min: The minimum value. @param max: The maximum value. - @type realtime: int - @param realtime: If non-zero (the default), the slider will emit events as - it is edited. @type tooltip: string @param tooltip: The button's tooltip (the string that appears when the mouse is kept over the button). |