Solve discrepancy between code and class reference for Plane #63381
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note that you can't simply rename the argument in the XML documentation. You need to rename it in the source where the method binding happens. If you run doctool locally, you will see that it will erase your change. For the same reason the CI won't pass. |
On godotengine#43310, class reference was automatically updated from source, causing xml documentation to disagree with parameter naming description on Plane.intersects_segment(). Weirdly, it also changed the parameter for Plane.is_point_over() from point to plane, when only the first has sense (and it is defined on math.Plane as "const Vector3 &p_point"). Manual mistake? * Update begin/end to from/to on Plane.intersects_segment(...) docs description to match source * Update Plane bindings to use points instread of plane for is_point_over(...) * Change Plane.is_point_over(plane) to Plane.is_point_over(point) AND its description on docs Fixes godotengine/godot-docs#5976
I see, thanks a lot for pointing it out. Apologies, I thought the doctool worked based on the cpp parameter, not its bindings- I am not super-familiar with the workflow. Now ./bin/godot.linuxbsd.tools.64 --doctool keeps the state after the patch (but I may have broken something else). |
|
It works, at least locally?
|
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On #43310, class reference was automatically updated from source,
causing xml documentation to disagree with parameter naming
description on Plane.intersects_segment().
The issue was a misleading binding argument name: while
Plane.is_point_over() is defined on math.Plane as
"const Vector3 &p_point", it was bound with the "plane"
argument indentifier.
docs description to match source
AND its description
Fixes godotengine/godot-docs#5976