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 documentation to PhysicsServer2DExtension #87018

Merged

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Jan 9, 2024

Oh goodness me.

This PR... This PR fills in the class reference of PhysicsServer2DExtension.

A grand majority of these methods link to the PhysicsServer2D equivalents. The reasons for this are as follow:

  • Curating whole new descriptions with the assumption that that they are overridable now is not something I would wish for to my dearest enemy. It could be my job and I wouldn't do it, at least not all at once.
  • Copying the descriptions between the two word-by-word would mean having to maintain two copies of the same identical description.
  • This documentation is tailored towards advanced users, even more "advanced" than those that would read PhysicsServer2D's class reference. They should roughly know what they're doing already.
    • Most of this documentation basically behaves like a quality of life "click here to read more".

Not all of them point back to PhysicsServer2D. Some have been described from scratch, because there's no equivalent of them exposed to the scripting languages.

Could use the feedback of physics-savvy maintainers, but I somehow have the confidence that the new descriptions are accurate enough.

@Mickeon Mickeon requested a review from a team as a code owner January 9, 2024 21:11
@Mickeon Mickeon force-pushed the documentation-PhysicsServer2DExtension branch from db6c267 to b7eee9d Compare January 9, 2024 21:34
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Jan 9, 2024
@AThousandShips AThousandShips added this to the 4.3 milestone Jan 9, 2024
@akien-mga akien-mga requested a review from rburing January 10, 2024 07:20
@Mickeon
Copy link
Contributor Author

Mickeon commented Feb 19, 2024

This and #87030 could still use a look

@akien-mga akien-mga merged commit 297a1c1 into godotengine:master Apr 8, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@akien-mga
Copy link
Member

Cherry-picked for 4.2.2.

@akien-mga akien-mga removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Apr 8, 2024
@akien-mga
Copy link
Member

Cherry-picked for 4.1.4.

@akien-mga akien-mga removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Apr 8, 2024
@Mickeon Mickeon deleted the documentation-PhysicsServer2DExtension branch April 8, 2024 14:07
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