-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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 PhysicsDirectBodyState2DExtension #87030
Add documentation to PhysicsDirectBodyState2DExtension #87030
Conversation
c917eea
to
f3815cb
Compare
f3815cb
to
9bbb2bc
Compare
Applied the new description to all methods that are setters/getters of a property in PhysicsDirectBodyState2D. |
For the rest "Overridable version of ..." still stands out to me. So I did some lookup, and what we have is: Virtual method to be implemented by the user. ... Override this method to ... Implement to ... Looks like my suggestion above wasn't the most consistent option. The most popular unique variation seems to be "Override this method to". And "Implement this in GDExtension to" is used specifically by another extension class. |
Indeed, "Override this method to" is the most consistent and also my favourite, I always try to word it that way.
One could also argue that introducing the method that way is needlessly verbose, too. "Override this method to customize the behavior of"... |
True, I would say that we almost don't even need descriptions, we just need a link to the non-extension class to explain what each methods connects to. Which can probably be automated somehow. I would add that calling it an overridable version is a bit of a misnomer, since that's not exactly how virtual methods work (at least not in every case). But eh, we can live with this as is for now, we shouldn't really be using this PR to harmonize all these descriptions. |
I'm okay with coming up with a standard description as a good starting point, so that it can be applied to #87018, as well. If it has to be with "that" description, so be it. |
How do we feel about this? Should the description be reverted back to what it was for consistency, at least? |
@Mickeon Ultimately it doesn't matter much as we're all over the place with these descriptions. So if content-wise this is fine, then we should just merge it as is. |
Thanks! |
Cherry-picked for 4.2.2. |
Cherry-picked for 4.1.4. |
Related to #87018
This..
This PR fills in all of PhysicsDirectBodyState2DExtension's class reference. What a mouthful. All of the descriptions end up just pointing back to the original PhysicsDirectBodyState2D. See #87018 for reasoning.
If both this PR and the prior one are acceptable, I will make a future PR for the 3D equivalents. Otherwise... I guess writing tailored documentation for these wouldn't be nearly as bad, given there's much fewer methods to talk about?