File tree Expand file tree Collapse file tree 1 file changed +13
-1
lines changed
docs/source/contributing/docs Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ In order to provide the best user experience,
5
5
it's important that typehints are chosen correctly.
6
6
With the large variety of types provided by Manim, choosing
7
7
which one to use can be difficult. This guide aims to
8
- aid you in the process.
8
+ aid you in the process of choosing the right type for the scenario .
9
9
10
10
11
11
The first step is figuring out which category your typehint fits into.
@@ -77,6 +77,18 @@ some form of ``Vector``.
77
77
78
78
Colors
79
79
------
80
+ The interface manim provides for working with colors is :class: `.ManimColor `.
81
+ The main color types Manim supports are RGB, RGBA, and HSV. You will want
82
+ to typehint a function depending on which type it uses. If any color will work,
83
+ you will need something like:
84
+
85
+ .. code-block :: python
86
+
87
+ if TYPE_CHECKING :
88
+ from manim.utils.color import ParsableManimColor
89
+
90
+ # typehint stuff with ParsableManimColor
91
+
80
92
81
93
82
94
Béziers
You can’t perform that action at this time.
0 commit comments