Cleanup: triple quotes for docstrings

This commit is contained in:
Campbell Barton 2017-04-14 20:01:43 +10:00
parent 6a8a679037
commit 0b55b8cc6a
4 changed files with 35 additions and 37 deletions

View File

@ -318,7 +318,7 @@ class BoundingBox:
class StrokeCollector(StrokeShader):
"Collects and Stores stroke objects"
"""Collects and Stores stroke objects"""
def __init__(self):
StrokeShader.__init__(self)
self.strokes = []

View File

@ -36,7 +36,7 @@ from bpy.props import (
class ANIM_OT_keying_set_export(Operator):
"Export Keying Set to a python script"
"""Export Keying Set to a python script"""
bl_idname = "anim.keying_set_export"
bl_label = "Export Keying Set..."
@ -102,15 +102,13 @@ class ANIM_OT_keying_set_export(Operator):
if ksp.id in id_to_paths_cache:
continue
"""
- idtype_list is used to get the list of id-datablocks from
bpy.data.* since this info isn't available elsewhere
- id.bl_rna.name gives a name suitable for UI,
with a capitalised first letter, but we need
the plural form that's all lower case
- special handling is needed for "nested" ID-blocks
(e.g. nodetree in Material)
"""
# - idtype_list is used to get the list of id-datablocks from
# bpy.data.* since this info isn't available elsewhere
# - id.bl_rna.name gives a name suitable for UI,
# with a capitalised first letter, but we need
# the plural form that's all lower case
# - special handling is needed for "nested" ID-blocks
# (e.g. nodetree in Material)
if ksp.id.bl_rna.identifier.startswith("ShaderNodeTree"):
# Find material or lamp using this node tree...
id_bpy_path = "bpy.data.nodes[\"%s\"]"

View File

@ -24,7 +24,7 @@ from bpy.props import BoolProperty
class VIEW3D_OT_edit_mesh_extrude_individual_move(Operator):
"Extrude individual elements and move"
"""Extrude individual elements and move"""
bl_label = "Extrude Individual and Move"
bl_idname = "view3d.edit_mesh_extrude_individual_move"
@ -62,7 +62,7 @@ class VIEW3D_OT_edit_mesh_extrude_individual_move(Operator):
class VIEW3D_OT_edit_mesh_extrude_move(Operator):
"Extrude and move along normals"
"""Extrude and move along normals"""
bl_label = "Extrude and Move on Normals"
bl_idname = "view3d.edit_mesh_extrude_move_normal"
@ -111,7 +111,7 @@ class VIEW3D_OT_edit_mesh_extrude_move(Operator):
class VIEW3D_OT_edit_mesh_extrude_shrink_fatten(Operator):
"Extrude and move along individual normals"
"""Extrude and move along individual normals"""
bl_label = "Extrude and Move on Individual Normals"
bl_idname = "view3d.edit_mesh_extrude_move_shrink_fatten"
@ -128,7 +128,7 @@ class VIEW3D_OT_edit_mesh_extrude_shrink_fatten(Operator):
class VIEW3D_OT_select_or_deselect_all(Operator):
"Select element under the mouse, deselect everything is there's nothing under the mouse"
"""Select element under the mouse, deselect everything is there's nothing under the mouse"""
bl_label = "Select or Deselect All"
bl_idname = "view3d.select_or_deselect_all"
bl_options = {'UNDO'}
@ -220,4 +220,4 @@ classes = (
VIEW3D_OT_edit_mesh_extrude_move,
VIEW3D_OT_edit_mesh_extrude_shrink_fatten,
VIEW3D_OT_select_or_deselect_all,
)
)

View File

@ -845,7 +845,7 @@ class WM_OT_context_modal_mouse(Operator):
class WM_OT_url_open(Operator):
"Open a website in the web-browser"
"""Open a website in the web-browser"""
bl_idname = "wm.url_open"
bl_label = ""
bl_options = {'INTERNAL'}
@ -862,7 +862,7 @@ class WM_OT_url_open(Operator):
class WM_OT_path_open(Operator):
"Open a path in a file browser"
"""Open a path in a file browser"""
bl_idname = "wm.path_open"
bl_label = ""
bl_options = {'INTERNAL'}
@ -1324,7 +1324,7 @@ class WM_OT_properties_add(Operator):
class WM_OT_properties_context_change(Operator):
"Jump to a different tab inside the properties editor"
"""Jump to a different tab inside the properties editor"""
bl_idname = "wm.properties_context_change"
bl_label = ""
bl_options = {'INTERNAL'}
@ -1532,7 +1532,7 @@ class WM_OT_blenderplayer_start(Operator):
class WM_OT_keyconfig_test(Operator):
"Test key-config for conflicts"
"""Test key-config for conflicts"""
bl_idname = "wm.keyconfig_test"
bl_label = "Test Key Configuration for Conflicts"
@ -1549,7 +1549,7 @@ class WM_OT_keyconfig_test(Operator):
class WM_OT_keyconfig_import(Operator):
"Import key configuration from a python script"
"""Import key configuration from a python script"""
bl_idname = "wm.keyconfig_import"
bl_label = "Import Key Configuration..."
@ -1616,7 +1616,7 @@ class WM_OT_keyconfig_import(Operator):
class WM_OT_keyconfig_export(Operator):
"Export key configuration to a python script"
"""Export key configuration to a python script"""
bl_idname = "wm.keyconfig_export"
bl_label = "Export Key Configuration..."
@ -1666,7 +1666,7 @@ class WM_OT_keyconfig_export(Operator):
class WM_OT_keymap_restore(Operator):
"Restore key map(s)"
"""Restore key map(s)"""
bl_idname = "wm.keymap_restore"
bl_label = "Restore Key Map(s)"
@ -1689,7 +1689,7 @@ class WM_OT_keymap_restore(Operator):
class WM_OT_keyitem_restore(Operator):
"Restore key map item"
"""Restore key map item"""
bl_idname = "wm.keyitem_restore"
bl_label = "Restore Key Map Item"
@ -1714,7 +1714,7 @@ class WM_OT_keyitem_restore(Operator):
class WM_OT_keyitem_add(Operator):
"Add key map item"
"""Add key map item"""
bl_idname = "wm.keyitem_add"
bl_label = "Add Key Map Item"
@ -1736,7 +1736,7 @@ class WM_OT_keyitem_add(Operator):
class WM_OT_keyitem_remove(Operator):
"Remove key map item"
"""Remove key map item"""
bl_idname = "wm.keyitem_remove"
bl_label = "Remove Key Map Item"
@ -1757,7 +1757,7 @@ class WM_OT_keyitem_remove(Operator):
class WM_OT_keyconfig_remove(Operator):
"Remove key config"
"""Remove key config"""
bl_idname = "wm.keyconfig_remove"
bl_label = "Remove Key Config"
@ -1775,7 +1775,7 @@ class WM_OT_keyconfig_remove(Operator):
class WM_OT_operator_cheat_sheet(Operator):
"List all the Operators in a text-block, useful for scripting"
"""List all the Operators in a text-block, useful for scripting"""
bl_idname = "wm.operator_cheat_sheet"
bl_label = "Operator Cheat Sheet"
@ -1804,7 +1804,7 @@ class WM_OT_operator_cheat_sheet(Operator):
# Add-on Operators
class WM_OT_addon_enable(Operator):
"Enable an add-on"
"""Enable an add-on"""
bl_idname = "wm.addon_enable"
bl_label = "Enable Add-on"
@ -1848,7 +1848,7 @@ class WM_OT_addon_enable(Operator):
class WM_OT_addon_disable(Operator):
"Disable an add-on"
"""Disable an add-on"""
bl_idname = "wm.addon_disable"
bl_label = "Disable Add-on"
@ -1877,7 +1877,7 @@ class WM_OT_addon_disable(Operator):
class WM_OT_theme_install(Operator):
"Load and apply a Blender XML theme file"
"""Load and apply a Blender XML theme file"""
bl_idname = "wm.theme_install"
bl_label = "Install Theme..."
@ -1939,7 +1939,7 @@ class WM_OT_theme_install(Operator):
class WM_OT_addon_refresh(Operator):
"Scan add-on directories for new modules"
"""Scan add-on directories for new modules"""
bl_idname = "wm.addon_refresh"
bl_label = "Refresh"
@ -1954,7 +1954,7 @@ class WM_OT_addon_refresh(Operator):
# Note: shares some logic with WM_OT_app_template_install
# but not enough to de-duplicate. Fixed here may apply to both.
class WM_OT_addon_install(Operator):
"Install an add-on"
"""Install an add-on"""
bl_idname = "wm.addon_install"
bl_label = "Install Add-on from File..."
@ -2108,7 +2108,7 @@ class WM_OT_addon_install(Operator):
class WM_OT_addon_remove(Operator):
"Delete the add-on from the file system"
"""Delete the add-on from the file system"""
bl_idname = "wm.addon_remove"
bl_label = "Remove Add-on"
@ -2167,7 +2167,7 @@ class WM_OT_addon_remove(Operator):
class WM_OT_addon_expand(Operator):
"Display information and preferences for this add-on"
"""Display information and preferences for this add-on"""
bl_idname = "wm.addon_expand"
bl_label = ""
bl_options = {'INTERNAL'}
@ -2191,7 +2191,7 @@ class WM_OT_addon_expand(Operator):
class WM_OT_addon_userpref_show(Operator):
"Show add-on user preferences"
"""Show add-on user preferences"""
bl_idname = "wm.addon_userpref_show"
bl_label = ""
bl_options = {'INTERNAL'}
@ -2223,7 +2223,7 @@ class WM_OT_addon_userpref_show(Operator):
# Note: shares some logic with WM_OT_addon_install
# but not enough to de-duplicate. Fixes here may apply to both.
class WM_OT_app_template_install(Operator):
"Install an application-template"
"""Install an application-template"""
bl_idname = "wm.app_template_install"
bl_label = "Install Template from File..."