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

Add missing descriptions to PhysicalBone3D class. #97609

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

Manik2607
Copy link
Contributor

Documentation Enhancements:

  • doc/classes/PhysicalBone3D.xml: Added detailed descriptions for methods such as apply_impulse, get_bone_id, and is_simulating_physics to explain their functionality and usage.
  • doc/classes/PhysicalBone3D.xml: Provided descriptions for constants like JOINT_TYPE_NONE, JOINT_TYPE_PIN, and JOINT_TYPE_6DOF to specify the types of joints that can be applied to PhysicalBone3D.dot documentation.

I have tried to be constant with other methods in godot.
Example : apply_impulse documentation is similar to apply_impulse in PhysicsBody3D.
Its my second contribution let me know if any changes are needed.

@Manik2607 Manik2607 requested a review from a team as a code owner September 29, 2024 07:07
@AThousandShips AThousandShips changed the title Added missing descriptions to PhysicalBone3D class. Add missing descriptions to PhysicalBone3D class. Sep 29, 2024
@AThousandShips AThousandShips added this to the 4.x milestone Sep 29, 2024
@AThousandShips AThousandShips requested a review from a team September 29, 2024 07:48
@Manik2607 Manik2607 force-pushed the master branch 2 times, most recently from 45b516e to 271a190 Compare October 1, 2024 06:47
@Manik2607
Copy link
Contributor Author

Manik2607 commented Oct 1, 2024

Do I need to open an issue that documentation is missing for this to work or not?
And it possible to work on other issues while this one is for review?

@Mickeon
Copy link
Contributor

Mickeon commented Oct 2, 2024

I already answered on RocketChat, but just for transparency

Do I need to open an issue that documentation is missing for this to work or not?

No reason to. Yes if the documentation was debatably inaccurate, but there was no documentation to speak of.

And it possible to work on other issues while this one is for review?

Of course

doc/classes/PhysicalBone3D.xml Outdated Show resolved Hide resolved
doc/classes/PhysicalBone3D.xml Outdated Show resolved Hide resolved
Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

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

Note that apply_impulse and apply_central_impulse's descriptions are copied from their respective RigidBody methods. They're not perfect, but they get the job done so this is fine.

The description of get_simulate_physics is still too vague, but it's better than nothing.

Completionism, here we go.

@Mickeon Mickeon modified the milestones: 4.x, 4.4 Oct 25, 2024
@Repiteo Repiteo merged commit 3ee0c0a into godotengine:master Nov 11, 2024
19 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Nov 11, 2024

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