[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [34379] trunk/blender/release/scripts/ modules/bpy_types.py: document Mesh.from_pydata() [#25688] undocumted functions in pyapi

[Campbell Barton]

Revision: 34379
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=34379
Author:   campbellbarton
Date:     2011-01-18 01:38:14 +0000 (Tue, 18 Jan 2011)
Log Message:
-----------
document Mesh.from_pydata() [#25688] undocumted functions in pyapi

Modified Paths:
--------------
    trunk/blender/release/scripts/modules/bpy_types.py

Modified: trunk/blender/release/scripts/modules/bpy_types.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_types.py	2011-01-18 01:04:14 UTC (rev 34378)
+++ trunk/blender/release/scripts/modules/bpy_types.py	2011-01-18 01:38:14 UTC (rev 34379)
@@ -302,10 +302,17 @@
 class Mesh(bpy_types.ID):
     __slots__ = ()
 
-    def from_pydata(self, verts, edges, faces):
+    def from_pydata(self, vertices, edges, faces):
         """
         Make a mesh from a list of verts/edges/faces
         Until we have a nicer way to make geometry, use this.
+
+        :arg vertices: float triplets each representing (X, Y, Z) eg: [(0.0, 1.0, 0.5), ...].
+        :type vertices: iterable object
+        :arg edges: int pairs, each pair contains two indices to the *vertices* argument. eg: [(1, 2), ...]
+        :type edges: iterable object
+        :arg faces: iterator of faces, each faces contains three or four indices to the *vertices* argument. eg: [(5, 6, 8, 9), (1, 2, 3), ...]
+        :type faces: iterable object
         """
         self.vertices.add(len(verts))
         self.edges.add(len(edges))