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

docs(contributing): add manim.typing guide #3669

Merged
merged 9 commits into from
Jun 22, 2024

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Apr 1, 2024

Motivation

It's important to document the intention behind each TypeAlias present in the manim.typing module, as well as explain when to use each. For example, InternalPoint3D vs Vector3D have very different connotations, but the same signature.

From the guide:

In order to provide the best user experience, it's important that typehints are chosen correctly. With the large variety of types provided by Manim, choosing which one to use can be difficult. This guide aims to aid you in the process of choosing the right type for the scenario.

Link to Changed Documentation

https://manimce--3669.org.readthedocs.build/en/3669/contributing/docs/types.html

Progress

  • Coordinates
  • Colors
  • Béziers
  • Functions
  • Images

CC @Viicos

@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Apr 1, 2024
@JasonGrace2282 JasonGrace2282 added this to the v0.18.1 milestone Apr 1, 2024
@JasonGrace2282 JasonGrace2282 added the typehints For adding/discussing typehints label Apr 18, 2024
@behackl behackl modified the milestones: v0.18.1, v0.19.0 Apr 24, 2024
@JasonGrace2282
Copy link
Member Author

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.

@JasonGrace2282 JasonGrace2282 marked this pull request as ready for review May 21, 2024 13:26
Copy link
Contributor

@chopan050 chopan050 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for your effort!
I left some comments around the document.

docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
docs/source/contributing/docs/types.rst Outdated Show resolved Hide resolved
@JasonGrace2282 JasonGrace2282 force-pushed the typing-guide branch 3 times, most recently from 2319d51 to a6d8212 Compare June 22, 2024 18:21
Copy link
Contributor

@chopan050 chopan050 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@chopan050 chopan050 enabled auto-merge (squash) June 22, 2024 20:06
@chopan050 chopan050 merged commit fdb4e37 into ManimCommunity:main Jun 22, 2024
17 of 18 checks passed
@JasonGrace2282 JasonGrace2282 deleted the typing-guide branch June 22, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation typehints For adding/discussing typehints
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants