Remove word duplicates in comments and strings, and fix casing and punctuation #88733

ryevdokimov · 2024-02-23T19:54:13Z

Used regex to find these. Ignored third party files.

Fixes: #88711

akien-mga · 2024-02-23T20:18:12Z

What regex did you use? Might be handy to re-run in the future as such issues slip through review.

ryevdokimov · 2024-02-23T20:30:19Z

Hold off on this, I found more with a refined search.

What regex did you use? Might be handy to re-run in the future as such issues slip through review.

Currently:

For comments: //.*\b(\w+)\b\s+\1\b (There are some results I ignored like owner owner, because I didn't know if it meant owner's owner, I didn't want to get too nitpicky)

For strings: (["'])(?:(?=(\?))\2.)?\b(\w+)\b(?:\s+\3\b)+(?:(?=(\?))\4.)?\1

Error messages: MSG(["'][a-z].*["'])

ryevdokimov · 2024-02-23T20:39:47Z

core/variant/variant_construct.h

@@ -661,7 +661,7 @@ class VariantConstructNoArgsNil {
 		VariantInternal::clear(r_ret);
 	}
 	static void ptr_construct(void *base, const void **p_args) {
-		ERR_FAIL_MSG("can't ptrcall nil constructor");
+		ERR_FAIL_MSG("Cannot ptrcall nil constructor");


Regex for MSG( starting with lower case, updated a few to fit other messages I found.

While at it, error messages should also end with a dot.

What about exclamation points? Should these become "." to be consistent? To me all errors are equally exciting.

https://github.com/godotengine/godot/blob/da4f50851d15c073ca413196aa1501fb97108c07/scene/resources/skeleton_modification_2d_twoboneik.cpp#L286

In most cases yeah, the exclamation mark might be overdoing it a bit. But that might imply further improving the phrasing for consistency with other similar errors, which may be outside the scope of this PR :)

Understood. Leaving them alone for now.

ryevdokimov · 2024-02-23T20:40:45Z

scene/resources/skeleton_modification_2d_twoboneik.cpp

 				joint_one_bone2d_node_cache = node->get_instance_id();

 				Bone2D *bone = Object::cast_to<Bone2D>(node);
 				if (bone) {
 					joint_one_bone_idx = bone->get_index_in_skeleton();
 				} else {
-					ERR_FAIL_MSG("update joint one Bone2D cache: Nodepath to Bone2D is not a Bone2D node!");


Lower case to upper case.

akien-mga · 2024-02-23T21:19:51Z

core/io/dir_access.h

+				ERR_FAIL_MSG("Cannot remove file or directory: " + p_path + ".");
 			}
 		} else {
-			ERR_FAIL_MSG("Cannot remove non-existent file or directory: " + p_path);
+			ERR_FAIL_MSG("Cannot remove non-existent file or directory: " + p_path + ".");


I think in this case, the omission was intentional, to avoid confusion at to whether the dot is part of the file path or not.

Oops, yeah that makes sense. I should avoid doing it to file paths. Agreed.

There are existing examples of adding the period at the end of the path. Would you like me to remove those?

godot/core/config/project_settings.cpp

Line 1096 in 87d40ba

ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "Unknown config file format: " + p_path + ".");

What's most commonly used currently?

Without the dot is used 3x as much.

vs

Let's standardize on no dots for these then.

core/math/basis.cpp

servers/rendering/rendering_device.cpp

ryevdokimov · 2024-02-23T22:23:33Z

drivers/d3d12/rendering_device_driver_d3d12.cpp

@@ -1860,7 +1860,7 @@ void RenderingDeviceDriverD3D12::command_pipeline_barrier(
 		VectorView<RDD::BufferBarrier> p_buffer_barriers,
 		VectorView<RDD::TextureBarrier> p_texture_barriers) {
 	if (p_src_stages.has_flag(PIPELINE_STAGE_ALL_COMMANDS_BIT) && p_dst_stages.has_flag(PIPELINE_STAGE_ALL_COMMANDS_BIT)) {
-		// Looks like the intent is a a full barrier.


Rebased to fix recent merge conflict and found another one in the process.

…nctuation

Mickeon · 2024-02-23T22:53:30Z

editor/editor_settings.cpp

@@ -1597,7 +1597,7 @@ void ED_SHORTCUT_OVERRIDE(const String &p_path, const String &p_feature, Key p_k
 	ERR_FAIL_NULL_MSG(EditorSettings::get_singleton(), "EditorSettings not instantiated yet.");

 	Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
-	ERR_FAIL_COND_MSG(!sc.is_valid(), "Used ED_SHORTCUT_OVERRIDE with invalid shortcut: " + p_path + ".");
+	ERR_FAIL_COND_MSG(!sc.is_valid(), "Used ED_SHORTCUT_OVERRIDE with invalid shortcut: " + p_path);


I don't understand, are error messages with paths meant to end with, or without punctuation? What's the rule here?

My understanding is without: #88733 (comment)

akien-mga · 2024-02-25T10:53:59Z

Thanks!

ryevdokimov requested review from a team as code owners February 23, 2024 19:54

KoBeWi added bug topic:codestyle labels Feb 23, 2024

KoBeWi added this to the 4.3 milestone Feb 23, 2024

akien-mga approved these changes Feb 23, 2024

View reviewed changes

ryevdokimov force-pushed the Remove-word-duplicates branch from 1dcafea to e7c832f Compare February 23, 2024 20:39

ryevdokimov commented Feb 23, 2024

View reviewed changes

ryevdokimov changed the title ~~Remove word duplicates in comments and strings~~ Remove word duplicates in comments and strings, and fix casing Feb 23, 2024

ryevdokimov force-pushed the Remove-word-duplicates branch 2 times, most recently from da4f508 to bd8ea9b Compare February 23, 2024 21:03

ryevdokimov requested a review from a team as a code owner February 23, 2024 21:03

ryevdokimov changed the title ~~Remove word duplicates in comments and strings, and fix casing~~ Remove word duplicates in comments and strings, and fix casing and punctuation Feb 23, 2024

akien-mga reviewed Feb 23, 2024

View reviewed changes

core/math/basis.cpp Outdated Show resolved Hide resolved

akien-mga reviewed Feb 23, 2024

View reviewed changes

servers/rendering/rendering_device.cpp Outdated Show resolved Hide resolved

akien-mga reviewed Feb 23, 2024

View reviewed changes

servers/rendering/rendering_device.cpp Outdated Show resolved Hide resolved

ryevdokimov force-pushed the Remove-word-duplicates branch 2 times, most recently from 610e331 to dd623b7 Compare February 23, 2024 22:06

akien-mga approved these changes Feb 23, 2024

View reviewed changes

ryevdokimov force-pushed the Remove-word-duplicates branch from dd623b7 to a205717 Compare February 23, 2024 22:21

ryevdokimov commented Feb 23, 2024

View reviewed changes

Remove word duplicates in comments and strings, and fix casing and pu…

13e8209

…nctuation

ryevdokimov force-pushed the Remove-word-duplicates branch from a205717 to 13e8209 Compare February 23, 2024 22:28

Mickeon reviewed Feb 23, 2024

View reviewed changes

akien-mga merged commit 83b32f9 into godotengine:master Feb 25, 2024
16 checks passed

ryevdokimov deleted the Remove-word-duplicates branch February 26, 2024 23:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove word duplicates in comments and strings, and fix casing and punctuation #88733

Remove word duplicates in comments and strings, and fix casing and punctuation #88733

ryevdokimov commented Feb 23, 2024

akien-mga commented Feb 23, 2024

ryevdokimov commented Feb 23, 2024 •

edited

Loading

ryevdokimov Feb 23, 2024

akien-mga Feb 23, 2024

ryevdokimov Feb 23, 2024 •

edited

Loading

akien-mga Feb 23, 2024

ryevdokimov Feb 23, 2024

ryevdokimov Feb 23, 2024

akien-mga Feb 23, 2024 •

edited

Loading

ryevdokimov Feb 23, 2024

ryevdokimov Feb 23, 2024

akien-mga Feb 23, 2024

ryevdokimov Feb 23, 2024

akien-mga Feb 23, 2024

ryevdokimov Feb 23, 2024

Mickeon Feb 23, 2024

ryevdokimov Feb 23, 2024

akien-mga commented Feb 25, 2024

Remove word duplicates in comments and strings, and fix casing and punctuation #88733

Remove word duplicates in comments and strings, and fix casing and punctuation #88733

Conversation

ryevdokimov commented Feb 23, 2024

akien-mga commented Feb 23, 2024

ryevdokimov commented Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryevdokimov Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akien-mga Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akien-mga commented Feb 25, 2024

ryevdokimov commented Feb 23, 2024 •

edited

Loading

ryevdokimov Feb 23, 2024 •

edited

Loading

akien-mga Feb 23, 2024 •

edited

Loading