Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Refactored docstrings in :mod:`.graphing` (#2571)

ad_chaos63b43ebf82e4
diff --git a/manim/mobject/graphing/functions.py b/manim/mobject/graphing/functions.py
index f59918dde..e93742057 100644
--- a/manim/mobject/graphing/functions.py
+++ b/manim/mobject/graphing/functions.py
@@ -39,7 +39,6 @@ class ParametricFunction(VMobject, metaclass=ConvertToOpenGL):
Examples
--------
-
.. manim:: PlotParametricFunction
:save_last_frame:
diff --git a/manim/mobject/graphing/number_line.py b/manim/mobject/graphing/number_line.py
index c54aebc8a..c7676a6b2 100644
--- a/manim/mobject/graphing/number_line.py
+++ b/manim/mobject/graphing/number_line.py
@@ -71,6 +71,13 @@ class NumberLine(Line):
kwargs
Additional arguments to be passed to :class:`~.Line`.
+
+ .. note::
+
+ Number ranges that include both negative and positive values will be generated
+ from the 0 point, and may not include a tick at the min / max
+ values as the tick locations are dependent on the step size.
+
Examples
--------
.. manim:: NumberLineExample
@@ -113,12 +120,6 @@ class NumberLine(Line):
line_group = VGroup(l0, l1, l2, l3).arrange(DOWN, buff=1)
self.add(line_group)
-
- .. note::
-
- Number ranges that include both negative and positive values will be generated
- from the 0 point, and may not include a tick at the min / max
- values as the tick locations are dependent on the step size.
"""
def __init__(
@@ -465,7 +466,6 @@ class NumberLine(Line):
The :class:`~.VMobject` class that will be used to construct the label.
Defaults to the ``label_constructor`` attribute of the number line
if not specified.
-
"""
if x_values is None:
x_values = self.get_tick_range()
diff --git a/manim/mobject/graphing/probability.py b/manim/mobject/graphing/probability.py
index 80d8df6cb..477b561be 100644
--- a/manim/mobject/graphing/probability.py
+++ b/manim/mobject/graphing/probability.py
@@ -38,7 +38,6 @@ class SampleSpace(Rectangle):
Examples
--------
-
.. manim:: ExampleSampleSpace
:save_last_frame:
@@ -398,7 +397,6 @@ class BarChart(Axes):
)
self.add(chart, c_bar_lbls)
-
"""
bar_labels = VGroup()
@@ -429,7 +427,6 @@ class BarChart(Axes):
Examples
--------
-
.. manim:: ChangeBarValuesExample
:save_last_frame:
diff --git a/manim/mobject/graphing/scale.py b/manim/mobject/graphing/scale.py
index 362599f36..2aaae7a5a 100644
--- a/manim/mobject/graphing/scale.py
+++ b/manim/mobject/graphing/scale.py
@@ -126,7 +126,6 @@ class LogBase(_ScaleBase):
Examples
--------
-
.. code-block:: python
func = ParametricFunction(lambda x: x, scaling=LogBase(base=2))
@@ -159,7 +158,6 @@ class LogBase(_ScaleBase):
Parameters
----------
-
val_range
The iterable of values used to create the labels. Determines the exponent.
unit_decimal_places