Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Add a note in the PR template asking devs to use changelog. (#405)

Aathish Sivasubrahmanianef9b59e48e99
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index c0cbc8c78..62dff43cd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -14,6 +14,9 @@ If you don't need any of the optional sections, feel free to delete them to prev
- Change 1
- Change 2
- and so on..
+
+Be sure to note your changes in the [changelog](docs/source/changelog.rst) if your
+changes warrant it!
-->
## Motivation
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
index 630704ccf..f2d0d4f35 100644
--- a/docs/source/changelog.rst
+++ b/docs/source/changelog.rst
@@ -58,6 +58,8 @@ Mobjects, Scenes, and Animations
#. Added Scene-caching feature. Now, if a partial movie file is unchanged in your code, it isn’t rendered again! [HIGHLY UNSTABLE We're working on it ;)]
#. Most :code:`get_` and :code:`set_` methods have been removed in favor of instance attributes and properties
#. The :code:`Container` class has been made into an AbstractBaseClass, i.e. in cannot be instantiated. Instead, use one of its children classes
+#. The ``TextMobject`` and ``TexMobject`` objects have been deprecated, due to their confusing names, in favour of ``Tex`` and ``MathTex``. You can still, however, continue to use ``TextMobject`` and ``TexMobject``, albeit with Deprecation Warnings constantly reminding you to switch.
+
Documentation