Skip to content

Update documentation and typings for ParametricFunction #3703

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.

Sign up for GitHub

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

Merged
merged 13 commits into from
Apr 19, 2024
Merged

Update documentation and typings for ParametricFunction #3703

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4b1778a
Update documentation and typings for ParametricFunction
xyzqm Apr 15, 2024
3f276d7
Use manim tyings
xyzqm Apr 15, 2024
dc17e5c
fix typings
xyzqm Apr 15, 2024
d860e52
a few doc fixes
xyzqm Apr 15, 2024
4a34c9f
Update manim/mobject/graphing/functions.py
xyzqm Apr 18, 2024
99efc23
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 18, 2024
af93c23
update typings
xyzqm Apr 18, 2024
0e89ad1
Merge branch 'parametric' of https://github.com/danielzsh/manim into …
xyzqm Apr 18, 2024
63b3a4f
remove extraneous line
xyzqm Apr 18, 2024
9ef0001
update example code
xyzqm Apr 18, 2024
87bb2d5
add line back for comptibility
xyzqm Apr 18, 2024
e52f99d
import TYPE_CHECKING
xyzqm Apr 18, 2024
fcce107
Merge branch 'main' into parametric
JasonGrace2282 Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions manim/mobject/graphing/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class ParametricFunction(VMobject, metaclass=ConvertToOpenGL):
Parameters
----------
function
The function to be plotted in the form of ``(lambda x: x**2)``
The function to be plotted in the form of ``(lambda t: (x(t), y(t), z(t)))``
t_range
Determines the length that the function spans. By default ``[0, 1]``
scaling
Expand Down Expand Up @@ -97,8 +97,8 @@ def construct(self):

def __init__(
self,
function: Callable[[float, float], float],
t_range: Sequence[float] | None = None,
function: Callable[[float], Sequence[float] | np.ndarray],
t_range: Sequence[float] | np.ndarray | None = None,
scaling: _ScaleBase = LinearBase(),
dt: float = 1e-8,
discontinuities: Iterable[float] | None = None,
Expand Down