Improve typing and doc for physics engines #1981
Draft
+90
−43
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
* Add link target for spatial hashing heading in performance tips * Use the top directive for the tip * Remove the types from the engine's docstrings * Initial cross-referencing with links to tutorials and example code * Clean up formatting
* Add missing return annotations * Rewrite docstring for is_on_ladder
* Use directives and clarity in docstring * Add cross-references * Split a gnarly if statement into an elif for readability * Add comments in function body
pushfoo
force-pushed
the
cleanup_physics_engines
branch
from
b9fad4b
to
5e28f48
Compare
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.
A follow-up to #1973 after reading through it.
Changes
Why
The physics engines are part of the most popular tutorial users interact with. Their doc and type annotations should live up to that to improve first-timer experience.