Skip to content

Fix differences between RayCast2D and RayCast3D documentation #105048

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

Merged

Conversation

Mickeon
Copy link
Member

@Mickeon Mickeon commented Apr 5, 2025

Similar to #104354

This PR addresses differences between the documentation of RayCast2D and RayCast3D (within reason). It also fixes an inconsistency that popped up as a result of #101373

This comes with the goal not only making the two consistent, but also reducing the overall amount of strings to localize.

@Mickeon Mickeon requested a review from a team as a code owner April 5, 2025 08:36
@Mickeon Mickeon added this to the 4.x milestone Apr 5, 2025
@Mickeon Mickeon requested a review from a team April 5, 2025 09:54
@Mickeon Mickeon force-pushed the documentation-no-differences-RayCast branch from c75ae67 to 0d0d24b Compare April 5, 2025 10:33
@Mickeon Mickeon requested a review from rburing April 5, 2025 10:41
@Mickeon Mickeon force-pushed the documentation-no-differences-RayCast branch from 0d0d24b to 01983d0 Compare April 6, 2025 09:08
@Mickeon Mickeon force-pushed the documentation-no-differences-RayCast branch from 01983d0 to b7c0aa5 Compare April 6, 2025 09:38
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 looks fine now from a physics perspective. Thanks!

I seem to recall a general comment saying that using parameter names as substitutes for words is not the most translation-friendly approach, but I'll leave that for someone else to decide.

@Mickeon Mickeon modified the milestones: 4.x, 4.5 Apr 6, 2025
@Mickeon
Copy link
Member Author

Mickeon commented Apr 6, 2025

I seem to recall a general comment saying that using parameter names as substitutes for words is not the most translation-friendly approach, but I'll leave that for someone else to decide.

That may be from me, actually, as well as from others. As personal notes, I wrote as follows:

Avoid using the [param] tag as a replacement for an important subject of the sentence. Ideally, rephrase the sentence as if the parameter names were generic, single-letter words. This makes descriptions easier to localize, while still keeping the [param] tags. Note that parameter names remain unlocalized.

Parameters replacing words something done very commonly across the class reference, and it's a bit debatable. There's no real guideline, too. In my opinion, linking the parameter directly here brings attention to its type without repetition and makes the subject clearer. But there's a lot of occasions where it does, in fact, suck.

@Mickeon Mickeon force-pushed the documentation-no-differences-RayCast branch from b7c0aa5 to 621500c Compare June 6, 2025 13:26
@akien-mga akien-mga merged commit 1792d4e into godotengine:master Jun 21, 2025
20 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the documentation-no-differences-RayCast branch June 21, 2025 13:15
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