godotengine / godot

Godot Engine – Multi-platform 2D and 3D game engine
https://godotengine.org
MIT License
90.44k stars 21.07k forks source link

[TRACKER] Typos and UI Paper Cuts #91521

Open RedMser opened 5 months ago

RedMser commented 5 months ago

As per https://github.com/godotengine/godot-proposals/issues/9648, this issue tracks tiny issues which can easily be fixed and are not opinionated changes. This includes:

It does NOT include any functional changes, such as refactoring or reordering code. Purpose of tracking these is NOT for users to make PRs for fixing them directly, but rather:

  1. For maintainers to periodically fix all of the listed issues in larger batches, instead of doing small PRs for individual issues.
  2. For contributors that are already touching code near a known issue, to fix it while they're at it.

A task list is used to keep track of how many issues there are, but you can simply remove the bullet points when done instead of checking them, to keep this tracker clean and re-usable.

Typos

Functional changes

Maintainers are free to edit this issue to add to the list or change wording. Other contributors are welcome to write comments and they'll be taken into account.

LunarTides commented 4 months ago

Can you add this to the tracker?

https://github.com/godotengine/godot/blob/96a386f3c424af96d950ee5098b4b0e4907c9508/doc/classes/DisplayServer.xml#L1753

-Transient window is will be destroyed...
+Transient window will be destroyed...
tetrapod00 commented 2 months ago

Grammar issues: Likely intended to be "...representing a GLTF accessor...": https://github.com/godotengine/godot/blob/96a386f3c424af96d950ee5098b4b0e4907c9508/modules/gltf/doc_classes/GLTFAccessor.xml#L7 Likely intended to be "...representing a GLTF bufferView...": https://github.com/godotengine/godot/blob/96a386f3c424af96d950ee5098b4b0e4907c9508/modules/gltf/doc_classes/GLTFBufferView.xml#L7

Edit: Addressed in https://github.com/godotengine/godot/pull/95578.

tetrapod00 commented 4 weeks ago

Many uses of camelCase instead of snake_case in this function: https://github.com/godotengine/godot/blob/e4e024ab88efe74677769395886bc1b09eccbac7/editor/plugins/visual_shader_editor_plugin.cpp#L3306

EAinsley commented 1 week ago

There are a lot of string concatenations that should be changed to vformat as suggested in the documentation. Maybe we should add this into the tracker as well?

RedMser commented 1 week ago

Maybe we should add this into the tracker as well?

Not sure if there is an easy way to find all these occurrences across the repository. But indeed these are the kind of changes that shouldn't be done as tiny PRs that change 1 place, but rather one large PR that fixes this on a broader scale, so it makes sense to do it together with tiny typo fixes like those listed here.

AThousandShips commented 1 week ago

One thing to search for would be: " + String it won't necessarily be very narrow or complete but it'd catch a lot I suspect, I'll take a look at some fixes myself

EAinsley commented 1 week ago

That would be too laborious. It would be better if someone just fix a little bit when they saw those code while working on a big commit and commit them alongside.

AThousandShips commented 1 week ago

If it touches the area sure, but only then, but these changes are best handled systematically