feat: documentation improvements #884
Merged
+3,481
−693
Conversation
This file contains hidden or 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
| } | ||
|
|
||
| /// Adds to this rigid-body a constant force at the given world-space point of this rigid-body. | ||
| /// Applies force at a specific point on the body (creates both force and torque). |
There was a problem hiding this comment.
I suggest Applies force at a specific world-space point (creates both force and torque) as what we have right now may suggest that it takes object coordinates. It is mentioned later, but still.
| /// - Magnetic/gravity fields | ||
| /// - Continuous pushing/pulling | ||
| /// | ||
| /// Forces are automatically cleared after each physics step, so you typically call this |
There was a problem hiding this comment.
Are the forces being cleared each step though? I'm not seeing that on my side - they seem to be additive.
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.
This generally improves the documentation and adds multiple doc-tests.
Most of these docs have been AI generated with manual intervention when needed. It turned out quite good compared to the previous state of the documentation. I still have to double-check some of the generated comments before merging but most of them look spot on.
This PR also adds a
Claude.mdfile for sourcing future usage of AI for docs and examples generation.