Skip to content

Conversation

@Mickeon
Copy link
Member

@Mickeon Mickeon commented Nov 28, 2025

Continuation of #107536

This PR addressed yet yet another huge chunk of class reference oddities I remembered to note down for later while localizing the class reference. Some of these are clear typos, some are inconsistencies, some are just awkward.

Of particular note:

  • Add tutorial in WebRTCPeerConnection
  • Reword some Skeleton3D-related descriptions
  • Replace a few occurrences of "shall" and "yield" with more common alternatives
  • Replace nasty [method duplicate][code](true)[/code]
  • Standardize the descriptions of both ProjectSettings.gui/common/swap_cancel_ok and EditorSettings.interface/editor/accept_dialog_cancel_ok_buttons
    • It may seem like the removal of corresponding integers is a notable loss of information, but usage of DisplayServer.get_swap_cancel_ok should be encouraged, instead.
  • Shift Dictionary.set's description around
  • Consistently refer to the "file cursor" as such in FileAccess
  • Encompass numerical values in [code] tags more often
  • Mention return value in ResourceUID.ensure_path
  • Remove unnecessary commas after "Returns [code]true[/code]"
  • Remove redundant leftover references to enums
  • Removed redundant warning in Mutex
  • Fix poor grammar in ProjectSettings.audio/general/text_to_speech
  • Fix inconsistent common "Accessibility debugging tools" note
  • Fix entirely incorrect sentence in Path3D.debug_custom_color
  • Fix Performance.NAVIGATION_2D/3D_ACTIVE_MAPS mentioning two maps, leftover from the NavigationServer split
  • Fix some missing articles on the way
  • Fix "parameters" being referred as "arguments" in a few places

For some of the descriptions affected, additional tweaks have been made to justify a whole translation string change.

@Mickeon Mickeon added this to the 4.6 milestone Nov 28, 2025
@Mickeon Mickeon added the bug label Nov 28, 2025
@Mickeon Mickeon requested a review from a team as a code owner November 28, 2025 00:40
@Mickeon Mickeon requested review from a team as code owners November 28, 2025 00:40
@Mickeon Mickeon requested review from a team as code owners November 28, 2025 00:40
@Mickeon Mickeon force-pushed the documentation-miscellaneous-oddities-part-7 branch from fedde33 to 2103fe3 Compare November 28, 2025 10:04
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.

The phrasing and formatting looks good to me, would be good to get some area eyes to make sure the descriptions are correct while we're here so we don't have to fix them again later

And of course make sure to remove the CI disable before merge

Returns [code]true[/code] if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value.
[b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop.
Returns [code]true[/code] if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value.
[b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some standalone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oo, this line isn't true anymore. I guess I should probably do this in another PR, but the truth is more like this:

Suggested change
[b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some standalone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop.
[b]Note:[/b] On Vulkan, also set [member Viewport.vrs_mode] to [code]VRS_XR[/code].

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't use the exact suggestion but I assume you meant something like this:

[b]Note:[/b] When using the Vulkan rendering driver, [member Viewport.vrs_mode] must be set to [constant Viewport.VRS_XR] to support foveation.

Copy link
Contributor

@dsnopek dsnopek left a comment

Choose a reason for hiding this comment

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

The XR related changes look good to me!

@Mickeon Mickeon force-pushed the documentation-miscellaneous-oddities-part-7 branch from 2103fe3 to 5b8b9ac Compare November 28, 2025 17:18
@Mickeon Mickeon force-pushed the documentation-miscellaneous-oddities-part-7 branch from 5b8b9ac to 4dec668 Compare November 28, 2025 17:19
Copy link
Contributor

@Repiteo Repiteo left a comment

Choose a reason for hiding this comment

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

Great work!

@Repiteo Repiteo merged commit 202e442 into godotengine:master Dec 3, 2025
20 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Dec 3, 2025

Thanks!

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