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

Replace some "uncommon" words in class reference #87223

Merged
merged 1 commit into from
Jan 16, 2024

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Jan 15, 2024

Over time some very "exotic" words have seeped through the class reference. This is not very good because the assumption is that non-native English speakers should be able to read the documentation, as well.

When it can be done, it's better to be consistent. Broad terms and less common words relative to the rest of the class reference should be avoided.

This PR may seem big, but don't be fooled. Most of these words can only be found twice at most across the class reference, anyway. Some typos on the way are fixed, as well.

The most notable replacements include:

  • "Untouched" -> "Unaffected", "Unchanged";
  • "standalone" -> "independent";
  • "Fine" -> "Good", "Precise" (depending on context);
  • "Notwithstanding" -> "Regardless of"; what the heck, guys? I had to look up this one, too!
  • "Disregards" -> "Ignores";
  • "Neglects to" -> "Fails to";

@Mickeon Mickeon requested a review from a team as a code owner January 15, 2024 16:37
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Jan 15, 2024
@AThousandShips AThousandShips added this to the 4.3 milestone Jan 15, 2024
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good otherwise

doc/classes/Array.xml Outdated Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-uncommon-words branch from 743b543 to 68d651b Compare January 15, 2024 16:40
doc/classes/Callable.xml Outdated Show resolved Hide resolved
doc/classes/Engine.xml Outdated Show resolved Hide resolved
@YuriSizov
Copy link
Contributor

Other than that, seems like a nice cleanup!

@Mickeon Mickeon force-pushed the documentation-uncommon-words branch from 68d651b to b461b1d Compare January 15, 2024 17:21
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 15, 2024

Thank you @AThousandShips and @YuriSizov for taking your time looking at this!

@Mickeon Mickeon force-pushed the documentation-uncommon-words branch from b461b1d to 61bdbdd Compare January 15, 2024 17:51
@akien-mga akien-mga merged commit 3ba18b3 into godotengine:master Jan 16, 2024
15 checks passed
@Mickeon Mickeon deleted the documentation-uncommon-words branch January 16, 2024 10:17
@akien-mga
Copy link
Member

Thanks!

@YuriSizov YuriSizov removed cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Jan 24, 2024
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.2.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants