lots of operator descriptions were incorrectly copy/pasted.
authorCampbell Barton <ideasman42@gmail.com>
Mon, 30 Sep 2013 05:50:41 +0000 (05:50 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 30 Sep 2013 05:50:41 +0000 (05:50 +0000)
update some descriptions, others were removed and operators tagged as internal.

add a script to detect duplicate operator descriptions.

22 files changed:
GNUmakefile
release/scripts/modules/rna_info.py
release/scripts/startup/bl_operators/uvcalc_lightmap.py
release/scripts/startup/bl_operators/wm.py
source/blender/bmesh/operators/bmo_edgenet.c
source/blender/editors/curve/editfont.c
source/blender/editors/interface/view2d_ops.c
source/blender/editors/mesh/editmesh_bisect.c
source/blender/editors/mesh/editmesh_tools.c
source/blender/editors/object/object_group.c
source/blender/editors/object/object_hook.c
source/blender/editors/sculpt_paint/paint_utils.c
source/blender/editors/sculpt_paint/paint_vertex.c
source/blender/editors/space_node/node_view.c
source/blender/editors/space_sequencer/sequencer_edit.c
source/blender/editors/space_sequencer/sequencer_modifier.c
source/blender/editors/space_sequencer/sequencer_select.c
source/blender/editors/space_text/text_ops.c
source/blender/editors/space_view3d/view3d_edit.c
source/blender/editors/space_view3d/view3d_view.c
source/blender/makesrna/intern/rna_gpencil.c
source/blender/makesrna/intern/rna_scene.c

index d5570a8e170e82ef788d14f623b4d0b2b2068ae8..417ff7770edb15cd4fdf710a25e0f2636df581b7 100644 (file)
@@ -182,6 +182,7 @@ help:
        @echo "  * check_spelling_c_qtc - same as check_spelling_c but outputs QtCreator tasks format"
        @echo "  * check_spelling_osl   - check for spelling errors (OSL only)"
        @echo "  * check_spelling_py    - check for spelling errors (Python only)"
+       @echo "  * check_descriptions   - check for duplicate/invalid descriptions"
        @echo ""
        @echo "Utilities (not associated with building blender)"
        @echo "  * icons    - updates PNG icons from SVG files."
@@ -313,6 +314,9 @@ check_spelling_c_qtc:
 check_spelling_osl:
        cd $(BUILD_DIR) ; PYTHONIOENCODING=utf_8 python3 $(BLENDER_DIR)/source/tools/spell_check_source.py $(BLENDER_DIR)/intern/cycles/kernel/shaders
 
+check_descriptions:
+       $(BUILD_DIR)/bin/blender --background -noaudio --factory-startup --python $(BLENDER_DIR)/source/tools/check_descriptions.py
+
 # -----------------------------------------------------------------------------
 # Utilities
 #
index a4fd2c996cb9999d55d480a97cac0a206e84c988..60b11884e30b74b8b5c117a80b822193d8b20b34 100644 (file)
@@ -648,7 +648,8 @@ def BuildRNAInfo():
             for prop in func.return_values:
                 prop.build()
 
-    if 1:
+    # there are too many invalid defaults, unless we intend to fix, leave this off
+    if 0:
         for rna_info in InfoStructRNA.global_lookup.values():
             for prop in rna_info.properties:
                 # ERROR CHECK
index f8f4b8d35e68f9fef970dbd46f161b7458cdbf61..6f54c051c0b341aedb8054ad4bd433e191c753fb 100644 (file)
@@ -556,8 +556,6 @@ def lightmap_uvpack(meshes,
 
     print("finished all %.2f " % (time.time() - t))
 
-    # Window.RedrawAll()
-
 
 def unwrap(operator, context, **kwargs):
 
@@ -590,7 +588,7 @@ from bpy.props import BoolProperty, FloatProperty, IntProperty
 
 
 class LightMapPack(Operator):
-    """Follow UVs from active quads along continuous face loops"""
+    """Pack each faces UV's into the UV bounds"""
     bl_idname = "uv.lightmap_pack"
     bl_label = "Lightmap Pack"
 
index 909842d3c2b76f1d74cbde1dc24ff72cebf3d54c..c1a98b07cbc1a95ad07d765a13a84aa0cd2dc8ab 100644 (file)
@@ -498,7 +498,7 @@ class WM_OT_context_menu_enum(Operator):
 
 
 class WM_OT_context_set_id(Operator):
-    """Toggle a context value"""
+    """Set a context value to an ID data-block"""
     bl_idname = "wm.context_set_id"
     bl_label = "Set Library ID"
     bl_options = {'UNDO', 'INTERNAL'}
@@ -903,8 +903,9 @@ class WM_OT_doc_view(Operator):
         return {'FINISHED'}
 
 
+'''
 class WM_OT_doc_edit(Operator):
-    """Load online reference docs"""
+    """Edit online reference docs"""
     bl_idname = "wm.doc_edit"
     bl_label = "Edit Documentation"
 
@@ -972,6 +973,7 @@ class WM_OT_doc_edit(Operator):
     def invoke(self, context, event):
         wm = context.window_manager
         return wm.invoke_props_dialog(self, width=600)
+'''
 
 
 rna_path = StringProperty(
@@ -1893,7 +1895,7 @@ class WM_OT_addon_install(Operator):
 
 
 class WM_OT_addon_remove(Operator):
-    "Disable an addon"
+    "Delete the addon from the filesystem"
     bl_idname = "wm.addon_remove"
     bl_label = "Remove Addon"
 
index c58a11f21ec691266bdd624cb74752b68042b8dd..fdee80b95057e58647c49a773d4323a207de55fa 100644 (file)
 #define EDGE_MARK      1
 #define EDGE_VIS       2
 
-#define FACE_NEW       1
-
 #define ELE_NEW                1
-#define ELE_ORIG       4
 
 void bmo_edgenet_fill_exec(BMesh *bm, BMOperator *op)
 {
index b9759e16f20a2481dc513329920ab8e8852fff8b..ac9c338e431544b7da5a0d1ea70c8567ec6edc99 100644 (file)
@@ -981,7 +981,7 @@ void FONT_OT_move_select(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Move Select";
-       ot->description = "Make selection from current cursor position to new cursor position type";
+       ot->description = "Move the cursor while selecting";
        ot->idname = "FONT_OT_move_select";
        
        /* api callbacks */
index 22c20842723bb2f2d89bd7040b8023dcee52cec9..0011366687299b3c643adbeb17aff81bda0af074 100644 (file)
@@ -1374,14 +1374,16 @@ static void VIEW2D_OT_smoothview(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Smooth View 2D";
-       ot->description = "Zoom in the view to the nearest item contained in the border";
+       ot->description = "";
        ot->idname = "VIEW2D_OT_smoothview";
 
        /* api callbacks */
        ot->invoke = view2d_smoothview_invoke;
-
        ot->poll = view2d_poll;
 
+       /* flags */
+       ot->flag = OPTYPE_INTERNAL;
+
        /* rna */
        WM_operator_properties_gesture_border(ot, FALSE);
 }
index afafd8458c50532f58ef9e218b6fd6bea11cb8a9..4cfee8cf6f2f2106fc5cf1563ed080aefd550bfc 100644 (file)
@@ -300,7 +300,7 @@ void MESH_OT_bisect(struct wmOperatorType *ot)
 
        /* identifiers */
        ot->name = "Bisect";
-       ot->description = "Enforce symmetry (both form and topological) across an axis";
+       ot->description = "Cuts geometry along a plane";
        ot->idname = "MESH_OT_bisect";
 
        /* api callbacks */
index f0e5a64b1bd626905da9bbcb92e55a1a317cc127..b5262bff8507f30c0730120248d5322b8ad5a2ef 100644 (file)
@@ -3342,7 +3342,7 @@ void MESH_OT_dissolve_verts(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Dissolve Vertices";
-       ot->description = "Dissolve geometry";
+       ot->description = "Dissolve verts, merge edges and faces";
        ot->idname = "MESH_OT_dissolve_verts";
 
        /* api callbacks */
@@ -3379,7 +3379,7 @@ void MESH_OT_dissolve_edges(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Dissolve Edges";
-       ot->description = "Dissolve geometry";
+       ot->description = "Dissolve edges, merging faces";
        ot->idname = "MESH_OT_dissolve_edges";
 
        /* api callbacks */
@@ -3418,7 +3418,7 @@ void MESH_OT_dissolve_faces(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Dissolve Faces";
-       ot->description = "Dissolve geometry";
+       ot->description = "Dissolve faces";
        ot->idname = "MESH_OT_dissolve_faces";
 
        /* api callbacks */
@@ -4519,7 +4519,7 @@ void MESH_OT_wireframe(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Wire Frame";
        ot->idname = "MESH_OT_wireframe";
-       ot->description = "Inset new faces into selected faces";
+       ot->description = "Create a solid wire-frame from faces";
 
        /* api callbacks */
        ot->exec = edbm_wireframe_exec;
index 1f52346222c07d888488aa742208de35e32681c4..a9fd3ce12889be1f6c044980011156315cf41b1e 100644 (file)
@@ -289,7 +289,7 @@ void GROUP_OT_objects_remove_all(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Remove From All Groups";
-       ot->description = "Remove selected objects from all groups or a selected group";
+       ot->description = "Remove selected objects from all groups";
        ot->idname = "GROUP_OT_objects_remove_all";
        
        /* api callbacks */
@@ -335,7 +335,7 @@ void GROUP_OT_objects_remove(wmOperatorType *ot)
 
        /* identifiers */
        ot->name = "Remove From Group";
-       ot->description = "Remove selected objects from all groups or a selected group";
+       ot->description = "Remove selected objects from a group";
        ot->idname = "GROUP_OT_objects_remove";
 
        /* api callbacks */
index 5b20489c9cba697f81cd6f7244316cbc3afcdd90..37656f82b25eefe7e681612faa122379f6f50ea4 100644 (file)
@@ -569,7 +569,7 @@ void OBJECT_OT_hook_add_selob(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Hook to Selected Object";
-       ot->description = "Hook selected vertices to the first selected Object";
+       ot->description = "Hook selected vertices to the first selected object";
        ot->idname = "OBJECT_OT_hook_add_selob";
        
        /* api callbacks */
@@ -603,7 +603,7 @@ void OBJECT_OT_hook_add_newob(wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "Hook to New Object";
-       ot->description = "Hook selected vertices to the first selected Object";
+       ot->description = "Hook selected vertices to a newly created object";
        ot->idname = "OBJECT_OT_hook_add_newob";
        
        /* api callbacks */
index d376bd3180fa27411a28562c89e913d837b33c62..bfc431baea51963cb9f780c16d9fdc68a660241c 100644 (file)
@@ -441,7 +441,7 @@ static int paint_select_linked_pick_invoke(bContext *C, wmOperator *op, const wm
 void PAINT_OT_face_select_linked_pick(wmOperatorType *ot)
 {
        ot->name = "Select Linked Pick";
-       ot->description = "Select linked faces";
+       ot->description = "Select linked faces under the cursor";
        ot->idname = "PAINT_OT_face_select_linked_pick";
 
        ot->invoke = paint_select_linked_pick_invoke;
index 538e8394b1f8d88b91b320bb187366fd04f1a02a..122dbae61290958ade0d8fbee22b1b118cdb3608 100644 (file)
@@ -3480,7 +3480,7 @@ void PAINT_OT_weight_gradient(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Weight Gradient";
        ot->idname = "PAINT_OT_weight_gradient";
-       ot->description = "Sample a line and show it in Scope panels";
+       ot->description = "Draw a line to apply a weight gradient to selected vertices";
 
        /* api callbacks */
        ot->invoke = paint_weight_gradient_invoke;
index e4a9c4fa5db958e6124f982c8d73c2e71fa7c2a6..f889a8ec97bc1b5e06eed63cbc75f6be8b14f59d 100644 (file)
@@ -373,7 +373,7 @@ void NODE_OT_backimage_fit(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Background Image Fit";
        ot->idname = "NODE_OT_backimage_fit";
-       ot->description = "Zoom in/out the background image";
+       ot->description = "Fit the background image to the view";
 
        /* api callbacks */
        ot->exec = backimage_fit_exec;
index d8b4824b52895540ede128a90ced3a0932b73452..8b2e7067eb9597423b8310510b24944df864aadc 100644 (file)
@@ -2960,7 +2960,7 @@ void SEQUENCER_OT_view_ghost_border(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Border Offset View";
        ot->idname = "SEQUENCER_OT_view_ghost_border";
-       ot->description = "Enable border select mode";
+       ot->description = "Set the boundaries of the border used for offset-view";
 
        /* api callbacks */
        ot->invoke = WM_border_select_invoke;
index 51df21e509a0db458cf9b9453cfcccb6f549728d..c8fd6e4b6eacfb0bfaf3af85487dd1bbbe536eef 100644 (file)
@@ -99,7 +99,7 @@ void SEQUENCER_OT_strip_modifier_add(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Add Strip Modifier";
        ot->idname = "SEQUENCER_OT_strip_modifier_add";
-       ot->description = "Add a modifier to strip";
+       ot->description = "Add a modifier to the strip";
 
        /* api callbacks */
        ot->exec = strip_modifier_add_exec;
@@ -142,7 +142,7 @@ void SEQUENCER_OT_strip_modifier_remove(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Remove Strip Modifier";
        ot->idname = "SEQUENCER_OT_strip_modifier_remove";
-       ot->description = "Add a modifier to strip";
+       ot->description = "Remove a modifier from the strip";
 
        /* api callbacks */
        ot->exec = strip_modifier_remove_exec;
index 254d15341cd3735fd06f663de5cd3176fc5adf73..45f05d56076dcbe439d7a65cfa97c7636153742f 100644 (file)
@@ -892,7 +892,7 @@ void SEQUENCER_OT_select_border(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Border Select";
        ot->idname = "SEQUENCER_OT_select_border";
-       ot->description = "Enable border select mode";
+       ot->description = "Select strips using border selection";
        
        /* api callbacks */
        ot->invoke = WM_border_select_invoke;
index 2c2a8b255dabfa4f24fd921dd081b5fa68796764..c078e612d680c0075d0d58296a125eb8e0bf0ea4 100644 (file)
@@ -1943,7 +1943,7 @@ void TEXT_OT_move_select(wmOperatorType *ot)
        /* identifiers */
        ot->name = "Move Select";
        ot->idname = "TEXT_OT_move_select";
-       ot->description = "Make selection from current cursor position to new cursor position type";
+       ot->description = "Move the cursor while selecting";
        
        /* api callbacks */
        ot->exec = text_move_select_exec;
@@ -2291,7 +2291,7 @@ void TEXT_OT_scroll(wmOperatorType *ot)
         * scroll_bar. Both do basically the same thing (aside 
         * from keymaps).*/
        ot->idname = "TEXT_OT_scroll";
-       ot->description = "Scroll text screen";
+       ot->description = "";
        
        /* api callbacks */
        ot->exec = text_scroll_exec;
@@ -2301,7 +2301,7 @@ void TEXT_OT_scroll(wmOperatorType *ot)
        ot->poll = text_scroll_poll;
 
        /* flags */
-       ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_POINTER;
+       ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_POINTER | OPTYPE_INTERNAL;
 
        /* properties */
        RNA_def_int(ot->srna, "lines", 1, INT_MIN, INT_MAX, "Lines", "Number of lines to scroll", -100, 100);
@@ -2385,7 +2385,7 @@ void TEXT_OT_scroll_bar(wmOperatorType *ot)
         * scroll. Both do basically the same thing (aside 
         * from keymaps).*/
        ot->idname = "TEXT_OT_scroll_bar";
-       ot->description = "Scroll text screen";
+       ot->description = "";
        
        /* api callbacks */
        ot->invoke = text_scroll_bar_invoke;
@@ -2394,7 +2394,7 @@ void TEXT_OT_scroll_bar(wmOperatorType *ot)
        ot->poll = text_region_scroll_poll;
 
        /* flags */
-       ot->flag = OPTYPE_BLOCKING;
+       ot->flag = OPTYPE_BLOCKING | OPTYPE_INTERNAL;
 
        /* properties */
        RNA_def_int(ot->srna, "lines", 1, INT_MIN, INT_MAX, "Lines", "Number of lines to scroll", -100, 100);
index 005bb5940bcdd65bc894a4909673104c1519ea31..67c9ea4599c6ee463e053e2fc446adef76860e21 100644 (file)
@@ -1257,7 +1257,7 @@ void VIEW3D_OT_ndof_orbit(struct wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "NDOF Orbit View";
-       ot->description = "Explore every angle of an object using the 3D mouse";
+       ot->description = "Orbit the view using the 3D mouse";
        ot->idname = "VIEW3D_OT_ndof_orbit";
 
        /* api callbacks */
@@ -1355,7 +1355,7 @@ void VIEW3D_OT_ndof_orbit_zoom(struct wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "NDOF Orbit View with Zoom";
-       ot->description = "Explore every angle of an object using the 3D mouse";
+       ot->description = "Orbit and zoom the view using the 3D mouse";
        ot->idname = "VIEW3D_OT_ndof_orbit_zoom";
 
        /* api callbacks */
@@ -1452,7 +1452,7 @@ void VIEW3D_OT_ndof_pan(struct wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "NDOF Pan View";
-       ot->description = "Position your viewpoint with the 3D mouse";
+       ot->description = "Pan the view with the 3D mouse";
        ot->idname = "VIEW3D_OT_ndof_pan";
 
        /* api callbacks */
@@ -1543,7 +1543,7 @@ void VIEW3D_OT_ndof_all(struct wmOperatorType *ot)
 {
        /* identifiers */
        ot->name = "NDOF Move View";
-       ot->description = "Position your viewpoint with the 3D mouse";
+       ot->description = "Pan and rotate the view with the 3D mouse";
        ot->idname = "VIEW3D_OT_ndof_all";
 
        /* api callbacks */
index 7e39c0b6be0b1d24a09cbf06064194fcd72d62fe..388d83d320832b9b0d493d84ffa1c0fcd4d23766 100644 (file)
@@ -378,12 +378,15 @@ void VIEW3D_OT_smoothview(wmOperatorType *ot)
        
        /* identifiers */
        ot->name = "Smooth View";
+       ot->description = "";
        ot->idname = "VIEW3D_OT_smoothview";
-       ot->description = "The time to animate the change of view (in milliseconds)";
        
        /* api callbacks */
        ot->invoke = view3d_smoothview_invoke;
        
+       /* flags */
+       ot->flag = OPTYPE_INTERNAL;
+
        ot->poll = ED_operator_view3d_active;
 }
 
index 8b65565fe4cf3bde9abd5072c03ce90528345889..6423763c49c54a8907005302553deb077a5d35cc 100644 (file)
@@ -354,15 +354,15 @@ static void rna_def_gpencil_strokes_api(BlenderRNA *brna, PropertyRNA *cprop)
        RNA_def_property_srna(cprop, "GPencilStrokes");
        srna = RNA_def_struct(brna, "GPencilStrokes", NULL);
        RNA_def_struct_sdna(srna, "bGPDframe");
-       RNA_def_struct_ui_text(srna, "Grease Pencil Frames", "Collection of grease pencil frames");
+       RNA_def_struct_ui_text(srna, "Grease Pencil Frames", "Collection of grease pencil stroke");
 
        func = RNA_def_function(srna, "new", "rna_GPencil_stroke_new");
-       RNA_def_function_ui_description(func, "Add a new grease pencil frame");
+       RNA_def_function_ui_description(func, "Add a new grease pencil stroke");
        parm = RNA_def_pointer(func, "stroke", "GPencilStroke", "", "The newly created stroke");
        RNA_def_function_return(func, parm);
 
        func = RNA_def_function(srna, "remove", "rna_GPencil_stroke_remove");
-       RNA_def_function_ui_description(func, "Remove a grease pencil frame");
+       RNA_def_function_ui_description(func, "Remove a grease pencil stroke");
        RNA_def_function_flag(func, FUNC_USE_REPORTS);
        parm = RNA_def_pointer(func, "stroke", "GPencilStroke", "Stroke", "The stroke to remove");
        RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
index fcaabaa3e65198b8f196607d4d54649dab874af4..f1a05700bd928831c780865c68053db4ede5d41c 100644 (file)
@@ -2072,8 +2072,8 @@ static void rna_def_statvis(BlenderRNA  *brna)
                {SCE_STATVIS_OVERHANG,  "OVERHANG",  0, "Overhang",  ""},
                {SCE_STATVIS_THICKNESS, "THICKNESS", 0, "Thickness", ""},
                {SCE_STATVIS_INTERSECT, "INTERSECT", 0, "Intersect", ""},
-               {SCE_STATVIS_DISTORT,   "DISTORT",   0, "Distort", ""},
-           {SCE_STATVIS_SHARP, "SHARP", 0, "Sharp", ""},
+               {SCE_STATVIS_DISTORT,   "DISTORT",   0, "Distortion", ""},
+               {SCE_STATVIS_SHARP, "SHARP", 0, "Sharp", ""},
                {0, NULL, 0, NULL, NULL}};
 
        srna = RNA_def_struct(brna, "MeshStatVis", NULL);