Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TRACKER] Typos and UI Paper Cuts #91521

Open
1 of 5 tasks
RedMser opened this issue May 3, 2024 · 8 comments
Open
1 of 5 tasks

[TRACKER] Typos and UI Paper Cuts #91521

RedMser opened this issue May 3, 2024 · 8 comments

Comments

@RedMser
Copy link
Contributor

RedMser commented May 3, 2024

As per godotengine/godot-proposals#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:

  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

  • core/object/script_language.cpp
    • typo: characacteristics -> characteristics
  • editor/plugins/visual_shader_editor_plugin.cpp at _setup_node function
    • code style: camelCase should be snake_case
  • scene/gui/code_edit.cpp
    • typo: all_ocurence -> all_occurrences (local variable)
  • doc/classes/SceneMultiplayer.xml

Functional changes

  • core/string/translation.cpp inside of TranslationServer::setup()
    • Add property hint ProjectSettings::get_singleton()->set_custom_property_info(PropertyInfo(Variant::STRING, "internationalization/locale/test", PROPERTY_HINT_LOCALE_ID, ""));

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

This comment was marked as resolved.

@tetrapod00
Copy link
Contributor

tetrapod00 commented Aug 15, 2024

Grammar issues:
Likely intended to be "...representing a GLTF accessor...":

GLTFAccessor is a data structure representing GLTF a [code]accessor[/code] that would be found in the [code]"accessors"[/code] array. A buffer is a blob of binary data. A buffer view is a slice of a buffer. An accessor is a typed interpretation of the data in a buffer view.

Likely intended to be "...representing a GLTF bufferView...":
GLTFBufferView is a data structure representing GLTF a [code]bufferView[/code] that would be found in the [code]"bufferViews"[/code] array. A buffer is a blob of binary data. A buffer view is a slice of a buffer that can be used to identify and extract data from the buffer.

Edit: Addressed in #95578.

@tetrapod00
Copy link
Contributor

Many uses of camelCase instead of snake_case in this function:

VisualShaderNodeFloatOp *floatOp = Object::cast_to<VisualShaderNodeFloatOp>(p_node);

@EAinsley
Copy link
Contributor

EAinsley commented Oct 9, 2024

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
Copy link
Contributor Author

RedMser commented Oct 9, 2024

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
Copy link
Member

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
Copy link
Contributor

EAinsley commented Oct 9, 2024

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

5 participants