[Bf-extensions-cvs] SVN commit: /data/svn/bf-extensions [3563] contrib/py/scripts/addons: Style edit (mostly), use """ for docstrings (not ''').

Bastien Montagne montagne29 at wanadoo.fr
Tue Jul 3 11:00:28 CEST 2012


Revision: 3563
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-extensions&revision=3563
Author:   mont29
Date:     2012-07-03 09:00:23 +0000 (Tue, 03 Jul 2012)
Log Message:
-----------
Style edit (mostly), use """ for docstrings (not ''').

Modified Paths:
--------------
    contrib/py/scripts/addons/add_curve_objects/add_curve_rectangle_259.py
    contrib/py/scripts/addons/add_curve_objects/cotejrp1_particle_tracer.py
    contrib/py/scripts/addons/add_curve_objects/cotejrp1_string_it.py
    contrib/py/scripts/addons/add_curve_objects/curve_simplify.py
    contrib/py/scripts/addons/add_mesh_column.py
    contrib/py/scripts/addons/add_mesh_rocks/rockgen.py
    contrib/py/scripts/addons/add_mesh_stairs/post.py
    contrib/py/scripts/addons/add_mesh_stairs/stairbuilder.py
    contrib/py/scripts/addons/add_mesh_walls/Blocks.py
    contrib/py/scripts/addons/add_mesh_walls/Wallfactory.py
    contrib/py/scripts/addons/anim_selection_sets.py
    contrib/py/scripts/addons/animation_motion_trail.py
    contrib/py/scripts/addons/btrace/bTrace.py
    contrib/py/scripts/addons/cursor_control/history.py
    contrib/py/scripts/addons/cursor_control/memory.py
    contrib/py/scripts/addons/cursor_control/operators.py
    contrib/py/scripts/addons/curve_tools.py
    contrib/py/scripts/addons/game_engine_ragdolls_kit/brik.py
    contrib/py/scripts/addons/game_engine_ragdolls_kit/brik_funcs.py
    contrib/py/scripts/addons/game_engine_ragdolls_kit/templates/brik_init_ragdoll.py
    contrib/py/scripts/addons/game_engine_ragdolls_kit/templates/brik_load.py
    contrib/py/scripts/addons/game_engine_ragdolls_kit/templates/brik_spawn.py
    contrib/py/scripts/addons/geodesic_domes/add_shape_geodesic.py
    contrib/py/scripts/addons/geodesic_domes/vefm_259.py
    contrib/py/scripts/addons/io_directx_bel/__init__.py
    contrib/py/scripts/addons/io_directx_bel/bel/material.py
    contrib/py/scripts/addons/io_directx_bel/bel/mesh.py
    contrib/py/scripts/addons/io_directx_bel/import_x.py
    contrib/py/scripts/addons/io_export_dxf/model/migiusModel.py
    contrib/py/scripts/addons/io_export_md3.py
    contrib/py/scripts/addons/io_import_BrushSet.py
    contrib/py/scripts/addons/io_import_fbx.py
    contrib/py/scripts/addons/io_import_voodoo_camera.py
    contrib/py/scripts/addons/io_points_pcd/__init__.py
    contrib/py/scripts/addons/io_points_pcd/pcd_utils.py
    contrib/py/scripts/addons/io_scene_open_street_map.py
    contrib/py/scripts/addons/io_scene_x/__init__.py
    contrib/py/scripts/addons/mesh_discombobulator.py
    contrib/py/scripts/addons/mesh_edge_intersection_tools.py
    contrib/py/scripts/addons/mesh_face_info_select.py
    contrib/py/scripts/addons/mesh_multi_extrude/mesh_bump.py
    contrib/py/scripts/addons/mesh_normal_smooth.py
    contrib/py/scripts/addons/object_batch_rename_datablocks.py
    contrib/py/scripts/addons/object_drop_to_ground.py
    contrib/py/scripts/addons/object_edit_linked.py
    contrib/py/scripts/addons/object_laplace_lightning.py
    contrib/py/scripts/addons/object_mangle_tools.py
    contrib/py/scripts/addons/object_render_wire.py
    contrib/py/scripts/addons/presets/keyconfig/blender_2012_experimental.py
    contrib/py/scripts/addons/space_view3d_enhanced_3d_cursor.py
    contrib/py/scripts/addons/space_view3d_manipulator_Menu.py
    contrib/py/scripts/addons/space_view3d_simple_align.py
    contrib/py/scripts/addons/text_editor_pasteall.py
    contrib/py/scripts/addons/text_intellisense.py
    contrib/py/scripts/addons/wetted_mesh.py

Modified: contrib/py/scripts/addons/add_curve_objects/add_curve_rectangle_259.py
===================================================================
--- contrib/py/scripts/addons/add_curve_objects/add_curve_rectangle_259.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_curve_objects/add_curve_rectangle_259.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -157,7 +157,7 @@
     return
 
 class rectangle(bpy.types.Operator):
-    ''''''
+    """"""
     bl_idname = "curve.rectangle"
     bl_label = "Rectangle"
     bl_options = {'REGISTER', 'UNDO'}

Modified: contrib/py/scripts/addons/add_curve_objects/cotejrp1_particle_tracer.py
===================================================================
--- contrib/py/scripts/addons/add_curve_objects/cotejrp1_particle_tracer.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_curve_objects/cotejrp1_particle_tracer.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -97,7 +97,7 @@
     
     
 class PTracerOp(bpy.types.Operator):
-    '''Tooltip'''
+    """Tooltip"""
     bl_idname = "curve.particle_tracer"
     bl_label = "Particle Tracer Options"
     bl_region_type = "VIEW_3D"

Modified: contrib/py/scripts/addons/add_curve_objects/cotejrp1_string_it.py
===================================================================
--- contrib/py/scripts/addons/add_curve_objects/cotejrp1_string_it.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_curve_objects/cotejrp1_string_it.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -48,7 +48,7 @@
     
 
 class StringItOperator(bpy.types.Operator):
-    '''Creates a curve that runs through the centers of each selected object.'''
+    """Creates a curve that runs through the centers of each selected object"""
     bl_idname = "curve.string_it_operator"
     bl_label = "String It Options"
     bl_options = { "REGISTER", "UNDO" }

Modified: contrib/py/scripts/addons/add_curve_objects/curve_simplify.py
===================================================================
--- contrib/py/scripts/addons/add_curve_objects/curve_simplify.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_curve_objects/curve_simplify.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -355,7 +355,7 @@
 #### ANIMATION CURVES OPERATOR ##################
 #################################################
 class GRAPH_OT_simplify(bpy.types.Operator):
-    ''''''
+    """"""
     bl_idname = "graph.simplify"
     bl_label = "simplifiy f-curves"
     bl_description = "simplify selected f-curves"
@@ -459,7 +459,7 @@
 ##### Curves OPERATOR #####
 ###########################
 class CURVE_OT_simplify(bpy.types.Operator):
-    ''''''
+    """"""
     bl_idname = "curve.simplify"
     bl_label = "simplifiy curves"
     bl_description = "simplify curves"

Modified: contrib/py/scripts/addons/add_mesh_column.py
===================================================================
--- contrib/py/scripts/addons/add_mesh_column.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_mesh_column.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -38,7 +38,7 @@
 }
 
 
-'''
+"""
 
 Create a column for use as an architectural element in a scene. Basically a glorified cylinder/cube.
 
@@ -51,7 +51,7 @@
 
 This script is based on features from add_mesh_gears, add_curve_aceous_galore.py, and add_mesh_BoltFactory/createMesh.py.
 
-'''
+"""
 
 #
 # List of "enhancements"/"fixes" needed to finalize this script.
@@ -159,7 +159,7 @@
 # @todo: handle odd number of sides (flat in middle).
 #
 def add_col_flute(angle, target, zpos, radius, Ad, sides=6):
-    '''
+    """
  Create "flute" for column at passed location.
 
     Parameters:
@@ -179,7 +179,7 @@
     Returns:
         newpoints - a list of coordinates for flute points (list of tuples), [[x,y,z],[x,y,z],...n]
             (type=list)
-    '''
+    """
     newpoints = []
 
     if sides < 2: sides = 2 # min number of sides.
@@ -327,7 +327,7 @@
 
 #####
 def add_col_face(angle, target, zpos, radius):
-    '''
+    """
 Calculate the vertex coordinates for column face.
 
     Parameters:
@@ -343,7 +343,7 @@
     Returns:
         a list of coordinates for column face points (list of four tuples), [[x,y,z],[x,y,z],...4]
             (type=list)
-    '''
+    """
     targStep = target/4
 
     verts_outer_face = [(radius * cos(angle+(targStep*I)), radius * sin(angle+(targStep*I)), zpos)
@@ -403,7 +403,7 @@
 #    base or capital if they shouldn't be same.
 #
 def add_extent(radius, height, width, zPos, type=1):
-    '''
+    """
 Create geometry for base/capital (shared function).
 
     Params:
@@ -416,7 +416,7 @@
     Returns:
 	list of vertices and edges
 
-    '''
+    """
     verts = []
     edges = []
 
@@ -614,7 +614,7 @@
 # @todo: Fix for starts, or factors not valid; return default (square) values on error.
 #
 def makeProfile(startY, startZ, endY, height, width, facets, factor1, factor2, doubler=True, twoPart=True, startRow=0):
-    '''
+    """
 Create list of vertexes and edges that outline defined shape (as per parameters).
 
     Params:
@@ -633,7 +633,7 @@
     Returns:
 	list of vertices and edges
 
-    '''
+    """
 
     # start here...
     shapeVerts = []
@@ -723,7 +723,7 @@
 # @todo: fix closing faces on top/bottom for flutes.
 #
 def add_column(colBase, radius, taper, c_faces, rows, height, flutes, Ad, fsides, skew, colCap=False):
-    '''
+    """
 Create column geometry.
 
     Params:
@@ -743,7 +743,7 @@
 	list of vertices
 	list of faces
 
-    '''
+    """
     if flutes: # set working faces and modulo/flag for doing flutes...
         c_faces -= c_faces % flutes
         fluteFaces = c_faces / flutes
@@ -806,12 +806,7 @@
 #####
 #
 class AddColumn(bpy.types.Operator):
-    '''
-Add a column mesh.
-
-    UI functions and object creation.
-
-    '''
+    """Add a column mesh"""
     bl_idname = "mesh.primitive_column"
     bl_label = "Add Column"
     bl_options = {'REGISTER', 'UNDO'}

Modified: contrib/py/scripts/addons/add_mesh_rocks/rockgen.py
===================================================================
--- contrib/py/scripts/addons/add_mesh_rocks/rockgen.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_mesh_rocks/rockgen.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -1350,7 +1350,7 @@
 # I have left it undocumented.
 
 class rocks(bpy.types.Operator):
-    '''Add rock objects'''
+    """Add rock objects"""
     bl_idname = "mesh.rocks"
     bl_label = "Add Rocks"
     bl_options = {'REGISTER', 'UNDO'}

Modified: contrib/py/scripts/addons/add_mesh_stairs/post.py
===================================================================
--- contrib/py/scripts/addons/add_mesh_stairs/post.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_mesh_stairs/post.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -55,7 +55,7 @@
         self.Create()
 
     def Intersect(self,i,d):
-        '''find intersection point, x, for rail and post'''
+        """find intersection point, x, for rail and post"""
         x3=self.x1+i*self.sp+Vector([d,d,d])
         x4=x3+Vector([0,0,self.x2[-1]])
         a=self.x2-self.x1

Modified: contrib/py/scripts/addons/add_mesh_stairs/stairbuilder.py
===================================================================
--- contrib/py/scripts/addons/add_mesh_stairs/stairbuilder.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_mesh_stairs/stairbuilder.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -89,7 +89,7 @@
 global run               
             
 class stairs(bpy.types.Operator):
-    '''Add stair objects'''
+    """Add stair objects"""
     bl_idname = "mesh.stairs"
     bl_label = "Add Stairs"
     bl_options = {'REGISTER', 'UNDO'}

Modified: contrib/py/scripts/addons/add_mesh_walls/Blocks.py
===================================================================
--- contrib/py/scripts/addons/add_mesh_walls/Blocks.py	2012-07-03 05:36:53 UTC (rev 3562)
+++ contrib/py/scripts/addons/add_mesh_walls/Blocks.py	2012-07-03 09:00:23 UTC (rev 3563)
@@ -157,7 +157,7 @@
 #For filling a linear space with divisions
 def fill(left, right, avedst, mindst=0.0, dev=0.0, pad=(0.0,0.0), num=0,
          center=0):
-    __doc__ = '''\
+    __doc__ = """\
     Fills a linear range with points and returns an ordered list of those points
     including the end points.
 
@@ -172,7 +172,7 @@
     num: substitutes a numerical limit for the right limit.  fill will then make
         a num+1 element list
     center: flag to center the elements in the range, 0 == disabled
-        '''
+        """
 
     poslist = [left]
     curpos = left+pad[0]
@@ -220,7 +220,7 @@
 #For generating block geometry
 def MakeABlock(bounds, segsize, vll=0, Offsets=None, FaceExclude=[],
                bevel=0, xBevScl=1):
-    __doc__ = '''\
+    __doc__ = """\
     MakeABlock returns lists of points and faces to be made into a square
             cornered block, subdivided along the length, with optional bevels.
     bounds: a list of boundary positions:
@@ -242,7 +242,7 @@
             ]
     FaceExclude: list of faces to exclude from the faces list.  see bounds above for indicies
     xBevScl: how much to divide the end (+- x axis) bevel dimensions.  Set to current average radius to compensate for angular distortion on curved blocks
-    '''
+    """
 
     slices = fill(bounds[0], bounds[1], segsize, segsize, center=1)
     points = []
@@ -304,7 +304,7 @@
 
 #For generating Keystone Geometry
 def MakeAKeystone(xpos, width, zpos, ztop, zbtm, thick, bevel, vll=0, FaceExclude=[], xBevScl=1):
-    __doc__ = '''\
+    __doc__ = """\
     MakeAKeystone returns lists of points and faces to be made into a square cornered keystone, with optional bevels.
     xpos: x position of the centerline
     width: x width of the keystone at the widest point (discounting bevels)
@@ -316,7 +316,7 @@
     vll: the number of vertexes already in the mesh. len(mesh.verts) should give this number
     faceExclude: list of faces to exclude from the faces list.  0:left, 1:right, 2:bottom, 3:top, 4:back, 5:front
     xBevScl: how much to divide the end (+- x axis) bevel dimensions.  Set to current average radius to compensate for angular distortion on curved blocks
-    '''
+    """
 
     points = []
     faces = []
@@ -496,8 +496,8 @@
     def edgeV(self, ht, s):
         dist = abs(self.x-ht)
         def radialAdjust(dist, sideVal):
-            '''take the distance and adjust for radial geometry, return dist.
-            '''

@@ Diff output truncated at 10240 characters. @@


More information about the Bf-extensions-cvs mailing list