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

Avoid punning [param enabled] in documentation #80066

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

timothyqiu
Copy link
Member

If [param enabled] the provided [param obstacle] affects avoidance using agents.

[param enabled] has to be kept in translation, so the pun will be lost because readers might not know what "enabled" means in English.

Currently, e.g. in Chinese, this sentence will be translated as if it's

If [param enabled] is [code]true[/code], the provided [param obstacle] affects avoidance using agents.

Weblate's complain about non-match BBCode has to be turned off manually for each entry. And either leaving a bare unmarked-up "true" in the description or translating "true" here feels wrong.

This PR changes If [param enabled] then XXX to If [param enabled] is [code]true[/code], then XXX, just like in other classrefs.

@timothyqiu timothyqiu added enhancement documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release labels Jul 30, 2023
@timothyqiu timothyqiu added this to the 4.2 milestone Jul 30, 2023
@timothyqiu timothyqiu requested a review from a team as a code owner July 30, 2023 16:46
Copy link
Member

@rburing rburing left a comment

Choose a reason for hiding this comment

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

This makes the documentation clearer also in English.

@YuriSizov YuriSizov merged commit dcd187d into godotengine:master Jul 31, 2023
@YuriSizov
Copy link
Contributor

Thanks!

@timothyqiu timothyqiu deleted the no-pun-intended branch August 1, 2023 00:55
@timothyqiu timothyqiu removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Sep 21, 2023
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.

3 participants