-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Added documentation for discontinuous functions #2279
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
Added documentation for discontinuous functions #2279
Conversation
Can you fix the docs build and merge conflict? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comment about phrasing, otherwise LGTM
manim/mobject/functions.py
Outdated
@@ -62,6 +66,28 @@ def construct(self): | |||
self.add(axes, curve1) | |||
self.set_camera_orientation(phi=80 * DEGREES, theta=-60 * DEGREES) | |||
self.wait() | |||
|
|||
.. attention:: | |||
In case your function contains discontinuous points, observe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this wording is a little strange. How about "If your function has discontinuities, you'll have to specify the location of the discontinuities manually. See the following example for guidance."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I think it'll be good to call "before" and "after" "incorrect" and "correct" instead. |
Variable names have been changed.
Overview: What does this pull request change?
discontinuities
anddt
Motivation and Explanation: Why and how do your changes improve the library?
The example added:
Outcome:
Links to added or changed documentation pages
Documentation
Further Information and Comments
Reviewer Checklist