diff options
author | Campbell Barton <ideasman42@gmail.com> | 2013-09-18 09:20:43 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2013-09-18 09:20:43 +0400 |
commit | b6631b8be74070562b4eb2c4230c7b6ffab92f4b (patch) | |
tree | f4158695369100f72999d383cc860df9603245ac /release/scripts | |
parent | dc4cded2c22656828499831f13471506ed59fc0a (diff) |
fixes for python api docs.
also move foreach_get/set examples into their own py example files (prefer not to have example code built into blenders binary).
Diffstat (limited to 'release/scripts')
-rw-r--r-- | release/scripts/modules/bpy/path.py | 2 | ||||
-rw-r--r-- | release/scripts/modules/bpy_extras/mesh_utils.py | 3 | ||||
-rw-r--r-- | release/scripts/modules/bpy_types.py | 10 | ||||
-rw-r--r-- | release/scripts/startup/bl_ui/__init__.py | 2 |
4 files changed, 10 insertions, 7 deletions
diff --git a/release/scripts/modules/bpy/path.py b/release/scripts/modules/bpy/path.py index 33039fa8494..e6ccb419059 100644 --- a/release/scripts/modules/bpy/path.py +++ b/release/scripts/modules/bpy/path.py @@ -121,7 +121,7 @@ def is_subdir(path, directory): def clean_name(name, replace="_"): """ Returns a name with characters replaced that - may cause problems under various circumstances, + may cause problems under various circumstances, such as writing to a file. All characters besides A-Z/a-z, 0-9 are replaced with "_" or the replace argument if defined. diff --git a/release/scripts/modules/bpy_extras/mesh_utils.py b/release/scripts/modules/bpy_extras/mesh_utils.py index d905964e71c..a92d2221c38 100644 --- a/release/scripts/modules/bpy_extras/mesh_utils.py +++ b/release/scripts/modules/bpy_extras/mesh_utils.py @@ -327,7 +327,8 @@ def ngon_tessellate(from_data, indices, fix_loops=True): indicie lists. Designed to be used for importers that need indices for an fgon to create from existing verts. - from_data: either a mesh, or a list/tuple of vectors. + :arg from_data: either a mesh, or a list/tuple of vectors. + :type from_data: list or :class:`bpy.types.Mesh` :arg indices: a list of indices to use this list is the ordered closed polyline to fill, and can be a subset of the data given. diff --git a/release/scripts/modules/bpy_types.py b/release/scripts/modules/bpy_types.py index f8870cbe705..819d3e112ff 100644 --- a/release/scripts/modules/bpy_types.py +++ b/release/scripts/modules/bpy_types.py @@ -219,8 +219,9 @@ class _GenericBone: @property def length(self): - """ The distance from head to tail, - when set the head is moved to fit the length. + """ + The distance from head to tail, + when set the head is moved to fit the length. """ return self.vector.length @@ -230,8 +231,9 @@ class _GenericBone: @property def vector(self): - """ The direction this bone is pointing. - Utility function for (tail - head) + """ + The direction this bone is pointing. + Utility function for (tail - head) """ return (self.tail - self.head) diff --git a/release/scripts/startup/bl_ui/__init__.py b/release/scripts/startup/bl_ui/__init__.py index 511f1705d5e..b1b1d0a4d73 100644 --- a/release/scripts/startup/bl_ui/__init__.py +++ b/release/scripts/startup/bl_ui/__init__.py @@ -152,7 +152,7 @@ class UI_UL_list(bpy.types.UIList): propname is the name of the string property to use for filtering. flags must be a list of integers the same length as items, or None! return a list of flags (based on given flags if not None), - or an empty list if no flags were given and no filtering has been done. + or an empty list if no flags were given and no filtering has been done. """ import fnmatch |