[TRACKER] Typos and UI Paper Cuts
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:
- A misspelling in the user interface or class reference
- A misspelling in the code (comment, variable name, class name, etc. as long as it is not a breaking change)
- Adding or tweaking the property hint of a property
- Giving names to unnamed method arguments
- Changing the "basic/advanced" status of Project Settings
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:
- For maintainers to periodically fix all of the listed issues in larger batches, instead of doing small PRs for individual issues.
- 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
- [ ]
core/object/script_language.cpp- typo:
characacteristics->characteristics
- typo:
- [ ]
editor/plugins/visual_shader_editor_plugin.cppat_setup_nodefunction- code style:
camelCaseshould besnake_case
- code style:
- [ ]
scene/gui/code_edit.cpp- typo:
all_ocurence->all_occurrences(local variable)
- typo:
- [ ]
doc/classes/SceneMultiplayer.xml- typo:
-The callback to execute when when receiving authentication data +The callback to execute when receiving authentication data
- typo:
Functional changes
- [ ]
core/string/translation.cppinside ofTranslationServer::setup()- Add property hint
ProjectSettings::get_singleton()->set_custom_property_info(PropertyInfo(Variant::STRING, "internationalization/locale/test", PROPERTY_HINT_LOCALE_ID, ""));
- Add property hint
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.
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...
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.
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
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?
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.
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
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.
If it touches the area sure, but only then, but these changes are best handled systematically
All currently listed typos / minor issues should be handled by #99799 (aside from the vformat suggestion, but that one is outside the scope of this tracker IMO, and also not a no brainer as currently vformat can be quite expensive).
Note: Please avoid starting long discussions of suggestions in this tracker, which makes it harder to use as a laundry list of things to do.
"Physical location" should use title case here ("Physical Location").
Node.find_children() should say "descendants" instead of "ancestors".
https://github.com/godotengine/godot/blob/816ec99355ef404451b30eb9a87fe450a3d09a14/doc/classes/FoldableContainer.xml#L50
"becomes" -> "become" (or remove "will", I don't know what is more correct)
https://github.com/godotengine/godot/blob/9dde5688a566775df338df8ae7023cb69b6cfe6d/platform/macos/export/export_plugin.cpp#L1087
Remove ">" at the end