-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
docs(contributing): add manim.typing guide #3669
Open
JasonGrace2282
wants to merge
10
commits into
ManimCommunity:main
Choose a base branch
from
JasonGrace2282:typing-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+138
−3
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
JasonGrace2282
force-pushed
the
typing-guide
branch
from
April 24, 2024 11:40
d38fc83
to
f917dc3
Compare
If anyone wants to write a quick description on the different representations of Béziers in Manim, feel free to push a commit adding it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Motivation
It's important to document the intention behind each
TypeAlias
present in themanim.typing
module, as well as explain when to use each. For example,InternalPoint3D
vsVector3D
have very different connotations, but the same signature.From the guide:
Link to Changed Documentation
https://manimce--3669.org.readthedocs.build/en/3669/contributing/docs/types.html
Progress
CC @Viicos