[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [36111] trunk/blender: less alarming warnings about the python api not being stable in online docs and remove from interactive console .

[Campbell Barton]

Revision: 36111
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=36111
Author:   campbellbarton
Date:     2011-04-12 12:09:38 +0000 (Tue, 12 Apr 2011)
Log Message:
-----------
less alarming warnings about the python api not being stable in online docs and remove from interactive console.

Modified Paths:
--------------
    trunk/blender/doc/python_api/sphinx_doc_gen.py
    trunk/blender/release/scripts/modules/console_python.py

Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py	2011-04-12 11:09:10 UTC (rev 36110)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py	2011-04-12 12:09:38 UTC (rev 36111)
@@ -879,8 +879,8 @@
     fw("project = 'Blender'\n")
     # fw("master_doc = 'index'\n")
     fw("copyright = u'Blender Foundation'\n")
-    fw("version = '%s - UNSTABLE API'\n" % version_string)
-    fw("release = '%s - UNSTABLE API'\n" % version_string)
+    fw("version = '%s - API'\n" % version_string)
+    fw("release = '%s - API'\n" % version_string)
     fw("html_theme = 'blender-org'\n")
     fw("html_theme_path = ['../']\n")
     fw("html_favicon = 'favicon.ico'\n")
@@ -908,21 +908,17 @@
     fw("\n")
     fw("`A PDF version of this document is also available <blender_python_reference_%s.pdf>`_\n" % version_string_fp)
     fw("\n")
-    fw(".. warning:: The Python API in Blender is **UNSTABLE**, It should only be used for testing, any script written now may break in future releases.\n")
+    fw(".. warning:: The Blender Python API has areas which are still in development.\n")
     fw("   \n")
     fw("   The following areas are subject to change.\n")
-    fw("      * operator names and arguments\n")
-    fw("      * render api\n")
-    fw("      * function calls with the data api (any function calls with values accessed from bpy.data), including functions for importing and exporting meshes\n")
-    fw("      * class registration (Operator, Panels, Menus, Headers)\n")
-    fw("      * modules: bpy.props, blf)\n")
-    fw("      * members in the bpy.context have to be reviewed\n")
-    fw("      * python defined modal operators, especially drawing callbacks are highly experemental\n")
+    fw("      * operator behavior, names and arguments\n")
+    fw("      * mesh creation and editing functions\n")
     fw("   \n")
     fw("   These parts of the API are relatively stable and are unlikely to change significantly\n")
     fw("      * data API, access to attributes of blender data such as mesh verts, material color, timeline frames and scene objects\n")
     fw("      * user interface functions for defining buttons, creation of menus, headers, panels\n")
-    fw("      * modules: bgl and mathutils\n")
+    fw("      * render engine integration\n")
+    fw("      * modules: bgl, mathutils\n")
     fw("      * game engine modules\n")
     fw("\n")
 

Modified: trunk/blender/release/scripts/modules/console_python.py
===================================================================
--- trunk/blender/release/scripts/modules/console_python.py	2011-04-12 11:09:10 UTC (rev 36110)
+++ trunk/blender/release/scripts/modules/console_python.py	2011-04-12 12:09:38 UTC (rev 36111)
@@ -296,11 +296,11 @@
     add_scrollback("Execute:             Enter", 'OUTPUT')
     add_scrollback("Autocomplete:        Ctrl+Space", 'OUTPUT')
     add_scrollback("Ctrl +/-  Wheel:     Zoom", 'OUTPUT')
-    add_scrollback("Builtin Modules:     bpy, bpy.data, bpy.ops, bpy.props, bpy.types, bpy.context, bgl, blf, mathutils", 'OUTPUT')
+    add_scrollback("Builtin Modules:     bpy, bpy.data, bpy.ops, bpy.props, bpy.types, bpy.context, bpy.utils, bgl, blf, mathutils", 'OUTPUT')
     add_scrollback("Convenience Imports: from mathutils import *; from math import *", 'OUTPUT')
     add_scrollback("", 'OUTPUT')
-    add_scrollback("  WARNING!!! Blender 2.5 API is subject to change, see API reference for more info.", 'ERROR')
-    add_scrollback("", 'OUTPUT')
+    # add_scrollback("  WARNING!!! Blender 2.5 API is subject to change, see API reference for more info.", 'ERROR')
+    # add_scrollback("", 'OUTPUT')
     sc.prompt = PROMPT
 
     return {'FINISHED'}