Tweak Joint2D and Joint3D documentation for consistency #87446
Merged
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
rburing
reviewed
Jan 21, 2024
Mickeon
force-pushed
the
documentation-Joint-tweaks
branch
from
02ec0cf
to
ab6022c
Compare
|
K-kindly removed the request from the documentation team. I LITERALLY AM THE DOCUMENTATION TEAM |
|
Well you'll have a hard time getting reviews without asking for reviews. The documentation team has more members than one ;) |
mhilbrunner
approved these changes
Apr 7, 2024
rburing
reviewed
Apr 7, 2024
doc/classes/Joint2D.xml
Outdated
| </member> | ||
| <member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath("")"> | ||
| The first body attached to the joint. Must derive from [PhysicsBody2D]. | ||
| Path to the first body (A) attached to the joint. The node must inherit [PhysicsBody2D]. | ||
| If left empty and [member node_b] is set, the body hangs as if attached to an invisible [StaticBody2D]. |
There was a problem hiding this comment.
This is currently only true for PinJoint2D. See the GodotPhysicsServer2D::joint_make_* methods (in contrast to the 3D equivalents). I think we should make the implementation consistent with 3D (so this documentation description becomes true), if it makes sense.
There was a problem hiding this comment.
Definitely. For now I can strip this detail from Joint2D but it should be the case...
rburing
reviewed
Apr 7, 2024
rburing
reviewed
Apr 7, 2024
Mickeon
force-pushed
the
documentation-Joint-tweaks
branch
from
ab6022c
to
4017b11
Compare
Mickeon
force-pushed
the
documentation-Joint-tweaks
branch
from
4017b11
to
0531f96
Compare
|
Updated the PR to address the above issues, you may look again. |
akien-mga
approved these changes
May 29, 2024
|
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.
Small tweaks to both Joint2D and Joint3D to make the wording consistent between the two. Also makes the description of
node_aandnode_bless misleading.