UI: Cleanup and fix labels and descriptions in various places

Changes include using proper and consistent grammar, simplifying
phrasing, using correct terminology, and not including python API
identifiers in tooltips.

Differential Revision: https://developer.blender.org/D9924
This commit is contained in:
Yevgeny Makarov
2021-02-24 13:25:44 -06:00
committed by Hans Goudey
parent 9a1b29e16c
commit 4f247dba5e
19 changed files with 41 additions and 40 deletions

View File

@@ -366,9 +366,9 @@ class AlignObjects(Operator):
bb_quality: BoolProperty(
name="High Quality",
description=(
"Enables high quality calculation of the "
"Enables high quality but slow calculation of the "
"bounding box for perfect results on complex "
"shape meshes with rotation/scale (Slow)"
"shape meshes with rotation/scale"
),
default=True,
)

View File

@@ -614,8 +614,8 @@ class LightMapPack(Operator):
PREF_PACK_IN_ONE: BoolProperty(
name="Share Texture Space",
description=(
"Objects Share texture space, map all objects "
"into 1 uvmap"
"Objects share texture space, map all objects "
"into a single UV map"
),
default=True,
)

View File

@@ -2284,7 +2284,7 @@ static void ANIM_OT_channels_expand(wmOperatorType *ot)
/* identifiers */
ot->name = "Expand Channels";
ot->idname = "ANIM_OT_channels_expand";
ot->description = "Expand (i.e. open) all selected expandable animation channels";
ot->description = "Expand (open) all selected expandable animation channels";
/* api callbacks */
ot->exec = animchannels_expand_exec;
@@ -2329,7 +2329,7 @@ static void ANIM_OT_channels_collapse(wmOperatorType *ot)
/* identifiers */
ot->name = "Collapse Channels";
ot->idname = "ANIM_OT_channels_collapse";
ot->description = "Collapse (i.e. close) all selected expandable animation channels";
ot->description = "Collapse (close) all selected expandable animation channels";
/* api callbacks */
ot->exec = animchannels_collapse_exec;

View File

@@ -6889,7 +6889,7 @@ void MESH_OT_sort_elements(wmOperatorType *ot)
"MATERIAL",
0,
"Material",
"Sort selected elements from smallest to greatest material index (faces only!)"},
"Sort selected faces from smallest to greatest material index"},
{SRT_SELECTED,
"SELECTED",
0,

View File

@@ -615,7 +615,7 @@ void OBJECT_OT_data_transfer(wmOperatorType *ot)
ot->name = "Transfer Mesh Data";
ot->idname = "OBJECT_OT_data_transfer";
ot->description =
"Transfer data layer(s) (weights, edge sharp, ...) from active to selected meshes";
"Transfer data layer(s) (weights, edge sharp, etc.) from active to selected meshes";
/* API callbacks.*/
ot->poll = data_transfer_poll;

View File

@@ -1311,7 +1311,7 @@ void OBJECT_OT_select_mirror(wmOperatorType *ot)
/* identifiers */
ot->name = "Select Mirror";
ot->description = "Select the Mirror objects of the selected object eg. L.sword -> R.sword";
ot->description = "Select the mirror objects of the selected object e.g. \"L.sword\" and \"R.sword\"";
ot->idname = "OBJECT_OT_select_mirror";
/* api callbacks */

View File

@@ -729,7 +729,7 @@ void NODE_OT_select_box(wmOperatorType *ot)
"tweak",
0,
"Tweak",
"Only activate when mouse is not over a node - useful for tweak gesture");
"Only activate when mouse is not over a node (useful for tweak gesture)");
WM_operator_properties_gesture_box(ot);
WM_operator_properties_select_operation_simple(ot);
@@ -905,7 +905,7 @@ void NODE_OT_select_lasso(wmOperatorType *ot)
"tweak",
0,
"Tweak",
"Only activate when mouse is not over a node - useful for tweak gesture");
"Only activate when mouse is not over a node (useful for tweak gesture)");
WM_operator_properties_gesture_lasso(ot);
WM_operator_properties_select_operation_simple(ot);

View File

@@ -1144,6 +1144,7 @@ void SEQUENCER_OT_effect_strip_add(struct wmOperatorType *ot)
"Type",
"Sequencer effect type");
sequencer_generic_props__internal(ot, SEQPROP_STARTFRAME | SEQPROP_ENDFRAME);
/* Only used when strip is of the Color type. */
prop = RNA_def_float_color(ot->srna,
"color",
3,
@@ -1151,7 +1152,7 @@ void SEQUENCER_OT_effect_strip_add(struct wmOperatorType *ot)
0.0f,
1.0f,
"Color",
"Initialize the strip with this color (only used when type='COLOR')",
"Initialize the strip with this color",
0.0f,
1.0f);
RNA_def_property_subtype(prop, PROP_COLOR_GAMMA);

View File

@@ -5274,7 +5274,7 @@ void VIEW3D_OT_cursor3d(wmOperatorType *ot)
static const EnumPropertyItem prop_shading_type_items[] = {
{OB_WIRE, "WIREFRAME", 0, "Wireframe", "Toggle wireframe shading"},
{OB_SOLID, "SOLID", 0, "Solid", "Toggle solid shading"},
{OB_MATERIAL, "MATERIAL", 0, "LookDev", "Toggle lookdev shading"},
{OB_MATERIAL, "MATERIAL", 0, "Material Preview", "Toggle material preview shading"},
{OB_RENDER, "RENDERED", 0, "Rendered", "Toggle rendered shading"},
{0, NULL, 0, NULL, NULL},
};

View File

@@ -112,7 +112,7 @@ const EnumPropertyItem rna_enum_beztriple_keyframe_type_items[] = {
"EXTREME",
ICON_KEYTYPE_EXTREME_VEC,
"Extreme",
"An 'extreme' pose, or some other purpose as needed"},
"An \"extreme\" pose, or some other purpose as needed"},
{BEZT_KEYTYPE_JITTER,
"JITTER",
ICON_KEYTYPE_JITTER_VEC,
@@ -128,7 +128,7 @@ const EnumPropertyItem rna_enum_beztriple_interpolation_easing_items[] = {
ICON_IPO_EASE_IN_OUT,
"Automatic Easing",
"Easing type is chosen automatically based on what the type of interpolation used "
"(e.g. 'Ease In' for transitional types, and 'Ease Out' for dynamic effects)"},
"(e.g. Ease In for transitional types, and Ease Out for dynamic effects)"},
{BEZT_IPO_EASE_IN,
"EASE_IN",

View File

@@ -1893,7 +1893,7 @@ static void rna_def_mloop(BlenderRNA *brna)
prop,
"Bitangent",
"Bitangent vector of this vertex for this polygon (must be computed beforehand using "
"calc_tangents, *use it only if really needed*, slower access than bitangent_sign)");
"calc_tangents, use it only if really needed, slower access than bitangent_sign)");
}
static void rna_def_mpolygon(BlenderRNA *brna)

View File

@@ -180,7 +180,7 @@ const EnumPropertyItem rna_enum_object_modifier_type_items[] = {
"Skin",
"Create a solid shape from vertices and edges, using the vertex radius to define the "
"thickness"},
{eModifierType_Solidify, "SOLIDIFY", ICON_MOD_SOLIDIFY, "Solidify", " Make the surface thick"},
{eModifierType_Solidify, "SOLIDIFY", ICON_MOD_SOLIDIFY, "Solidify", "Make the surface thick"},
{eModifierType_Subsurf,
"SUBSURF",
ICON_MOD_SUBSURF,
@@ -279,7 +279,7 @@ const EnumPropertyItem rna_enum_object_modifier_type_items[] = {
"WAVE",
ICON_MOD_WAVE,
"Wave",
"Adds a ripple-like motion to an objects geometry"},
"Adds a ripple-like motion to an object's geometry"},
{eModifierType_VolumeDisplace,
"VOLUME_DISPLACE",
ICON_VOLUME_DATA,
@@ -4562,7 +4562,7 @@ static void rna_def_modifier_solidify(BlenderRNA *brna)
0,
"Complex",
"Output a manifold mesh even if the base mesh is non-manifold, "
"where edges have 3 or more connecting faces."
"where edges have 3 or more connecting faces. "
"This method is slower"},
{0, NULL, 0, NULL, NULL},
};
@@ -6740,7 +6740,7 @@ static void rna_def_modifier_normaledit(BlenderRNA *brna)
"MUL",
0,
"Multiply",
"Copy product of old and new normals (*not* cross product)"},
"Copy product of old and new normals (not cross product)"},
{0, NULL, 0, NULL, NULL},
};

View File

@@ -2783,7 +2783,7 @@ static void rna_def_particle_settings(BlenderRNA *brna)
RNA_def_property_float_sdna(prop, NULL, "draw_size");
RNA_def_property_range(prop, 0, 1000);
RNA_def_property_ui_range(prop, 0, 100, 1, -1);
RNA_def_property_ui_text(prop, "Draw Size", "Size of particles on viewport in BU");
RNA_def_property_ui_text(prop, "Draw Size", "Size of particles on viewport");
RNA_def_property_update(prop, 0, "rna_Particle_redo");
prop = RNA_def_property(srna, "child_type", PROP_ENUM, PROP_NONE);
@@ -2860,7 +2860,7 @@ static void rna_def_particle_settings(BlenderRNA *brna)
RNA_def_property_ui_text(prop,
"Integration",
"Algorithm used to calculate physics, from the fastest to the "
"most stable/accurate: Midpoint, Euler, Verlet, RK4 (Old)");
"most stable and accurate: Midpoint, Euler, Verlet, RK4");
RNA_def_property_update(prop, 0, "rna_Particle_reset");
prop = RNA_def_property(srna, "kink", PROP_ENUM, PROP_NONE);
@@ -3163,14 +3163,14 @@ static void rna_def_particle_settings(BlenderRNA *brna)
RNA_def_property_int_sdna(prop, NULL, "child_nbr"); /*optional if prop names are the same */
RNA_def_property_range(prop, 0, 100000);
RNA_def_property_ui_range(prop, 0, 1000, 1, -1);
RNA_def_property_ui_text(prop, "Children Per Parent", "Number of children/parent");
RNA_def_property_ui_text(prop, "Children Per Parent", "Number of children per parent");
RNA_def_property_update(prop, 0, "rna_Particle_redo_child");
prop = RNA_def_property(srna, "rendered_child_count", PROP_INT, PROP_NONE);
RNA_def_property_int_sdna(prop, NULL, "ren_child_nbr");
RNA_def_property_range(prop, 0, 100000);
RNA_def_property_ui_range(prop, 0, 10000, 1, -1);
RNA_def_property_ui_text(prop, "Rendered Children", "Number of children/parent for rendering");
RNA_def_property_ui_text(prop, "Rendered Children", "Number of children per parent for rendering");
prop = RNA_def_property(srna, "virtual_parents", PROP_FLOAT, PROP_FACTOR);
RNA_def_property_float_sdna(prop, NULL, "parents");

View File

@@ -262,7 +262,7 @@ const EnumPropertyItem rna_enum_curve_fit_method_items[] = {
#define R_IMF_ENUM_BMP \
{R_IMF_IMTYPE_BMP, "BMP", ICON_FILE_IMAGE, "BMP", "Output image in bitmap format"},
#define R_IMF_ENUM_IRIS \
{R_IMF_IMTYPE_IRIS, "IRIS", ICON_FILE_IMAGE, "Iris", "Output image in (old!) SGI IRIS format"},
{R_IMF_IMTYPE_IRIS, "IRIS", ICON_FILE_IMAGE, "Iris", "Output image in SGI IRIS format"},
#define R_IMF_ENUM_PNG \
{R_IMF_IMTYPE_PNG, "PNG", ICON_FILE_IMAGE, "PNG", "Output image in PNG format"},
#define R_IMF_ENUM_JPEG \

View File

@@ -4336,7 +4336,7 @@ static void rna_def_space_view3d(BlenderRNA *brna)
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
RNA_def_property_ui_text(prop,
"Render Region",
"Use a region within the frame size for rendered viewport"
"Use a region within the frame size for rendered viewport "
"(when not viewing through the camera)");
RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);

View File

@@ -96,7 +96,7 @@ static void rna_def_speaker(BlenderRNA *brna)
RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
RNA_def_property_range(prop, 0.0f, FLT_MAX);
RNA_def_property_ui_text(
prop, "Reference Distance", "Reference distance at which volume is 100 %");
prop, "Reference Distance", "Reference distance at which volume is 100%");
/* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_distance_reference_set", NULL); */
/* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */
@@ -125,7 +125,7 @@ static void rna_def_speaker(BlenderRNA *brna)
RNA_def_property_ui_text(
prop,
"Inner Cone Angle",
"Angle of the inner cone, in degrees, inside the cone the volume is 100 %");
"Angle of the inner cone, in degrees, inside the cone the volume is 100%");
/* RNA_def_property_float_funcs(prop, NULL, "rna_Speaker_cone_angle_inner_set", NULL); */
/* RNA_def_property_update(prop, 0, "rna_Speaker_update"); */

View File

@@ -3544,59 +3544,59 @@ static void rna_def_userdef_theme_space_nla(BlenderRNA *brna)
prop = RNA_def_property(srna, "strips", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "strip");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(prop, "Strips", "Action-Clip Strip - Unselected");
RNA_def_property_ui_text(prop, "Strips", "Unselected Action-Clip Strip");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "strips_selected", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "strip_select");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(prop, "Strips Selected", "Action-Clip Strip - Selected");
RNA_def_property_ui_text(prop, "Strips Selected", "Selected Action-Clip Strip");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "transition_strips", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_transition");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(prop, "Transitions", "Transition Strip - Unselected");
RNA_def_property_ui_text(prop, "Transitions", "Unselected Transition Strip");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "transition_strips_selected", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_transition_sel");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(prop, "Transitions Selected", "Transition Strip - Selected");
RNA_def_property_ui_text(prop, "Transitions Selected", "Selected Transition Strip");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "meta_strips", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_meta");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(
prop, "Meta Strips", "Meta Strip - Unselected (for grouping related strips)");
prop, "Meta Strips", "Unselected Meta Strip (for grouping related strips)");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "meta_strips_selected", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_meta_sel");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(
prop, "Meta Strips Selected", "Meta Strip - Selected (for grouping related strips)");
prop, "Meta Strips Selected", "Selected Meta Strip (for grouping related strips)");
RNA_def_property_update(prop, 0, "rna_userdef_update");
prop = RNA_def_property(srna, "sound_strips", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_sound");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(
prop, "Sound Strips", "Sound Strip - Unselected (for timing speaker sounds)");
prop, "Sound Strips", "Unselected Sound Strip (for timing speaker sounds)");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "sound_strips_selected", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_sound_sel");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(
prop, "Sound Strips Selected", "Sound Strip - Selected (for timing speaker sounds)");
prop, "Sound Strips Selected", "Selected Sound Strip (for timing speaker sounds)");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "tweak", PROP_FLOAT, PROP_COLOR_GAMMA);
RNA_def_property_float_sdna(prop, NULL, "nla_tweaking");
RNA_def_property_array(prop, 3);
RNA_def_property_ui_text(prop, "Tweak", "Color for strip/action being 'tweaked' or edited");
RNA_def_property_ui_text(prop, "Tweak", "Color for strip/action being \"tweaked\" or edited");
RNA_def_property_update(prop, 0, "rna_userdef_theme_update");
prop = RNA_def_property(srna, "tweak_duplicate", PROP_FLOAT, PROP_COLOR_GAMMA);
@@ -6022,7 +6022,7 @@ static void rna_def_userdef_filepaths(BlenderRNA *brna)
static const EnumPropertyItem anim_player_presets[] = {
{0, "INTERNAL", 0, "Internal", "Built-in animation player"},
{2, "DJV", 0, "DJV", "Open source frame player: http://djv.sourceforge.net"},
{2, "DJV", 0, "DJV", "Open source frame player"},
{3, "FRAMECYCLER", 0, "FrameCycler", "Frame player from IRIDAS"},
{4, "RV", 0, "RV", "Frame player from Tweak Software"},
{5, "MPLAYER", 0, "MPlayer", "Media player for video and PNG/JPEG/SGI image sequences"},

View File

@@ -629,7 +629,7 @@ void WM_OT_append(wmOperatorType *ot)
"set_fake",
false,
"Fake User",
"Set Fake User for appended items (except Objects and Groups)");
"Set \"Fake User\" for appended items (except objects and collections)");
RNA_def_boolean(
ot->srna,
"use_recursive",

View File

@@ -3010,7 +3010,7 @@ static void WM_OT_radial_control(wmOperatorType *ot)
{
ot->name = "Radial Control";
ot->idname = "WM_OT_radial_control";
ot->description = "Set some size property (like e.g. brush size) with mouse wheel";
ot->description = "Set some size property (e.g. brush size) with mouse wheel";
ot->invoke = radial_control_invoke;
ot->modal = radial_control_modal;