Skip to content

Commit 63b43eb

Browse files
authored
Refactored docstrings in :mod:.graphing (#2571)
* Refactored docstrings in manim.mobject.graphing.functions * Refactored docstrings in manim.mobject.graphing.number_line * Refactored docstrings in manim.mobject.graphing.probability * Refactored doctrings in manim.mobject.graphing.scale * Trigger build
1 parent f5af1bb commit 63b43eb

File tree

4 files changed

+7
-13
lines changed

4 files changed

+7
-13
lines changed

manim/mobject/graphing/functions.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ class ParametricFunction(VMobject, metaclass=ConvertToOpenGL):
3939
4040
Examples
4141
--------
42-
4342
.. manim:: PlotParametricFunction
4443
:save_last_frame:
4544

manim/mobject/graphing/number_line.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,13 @@ class NumberLine(Line):
7171
kwargs
7272
Additional arguments to be passed to :class:`~.Line`.
7373
74+
75+
.. note::
76+
77+
Number ranges that include both negative and positive values will be generated
78+
from the 0 point, and may not include a tick at the min / max
79+
values as the tick locations are dependent on the step size.
80+
7481
Examples
7582
--------
7683
.. manim:: NumberLineExample
@@ -113,12 +120,6 @@ def construct(self):
113120
114121
line_group = VGroup(l0, l1, l2, l3).arrange(DOWN, buff=1)
115122
self.add(line_group)
116-
117-
.. note::
118-
119-
Number ranges that include both negative and positive values will be generated
120-
from the 0 point, and may not include a tick at the min / max
121-
values as the tick locations are dependent on the step size.
122123
"""
123124

124125
def __init__(
@@ -465,7 +466,6 @@ def add_numbers(
465466
The :class:`~.VMobject` class that will be used to construct the label.
466467
Defaults to the ``label_constructor`` attribute of the number line
467468
if not specified.
468-
469469
"""
470470
if x_values is None:
471471
x_values = self.get_tick_range()

manim/mobject/graphing/probability.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ class SampleSpace(Rectangle):
3838
3939
Examples
4040
--------
41-
4241
.. manim:: ExampleSampleSpace
4342
:save_last_frame:
4443
@@ -398,7 +397,6 @@ def construct(self):
398397
)
399398
400399
self.add(chart, c_bar_lbls)
401-
402400
"""
403401

404402
bar_labels = VGroup()
@@ -429,7 +427,6 @@ def change_bar_values(self, values: Iterable[float]):
429427
430428
Examples
431429
--------
432-
433430
.. manim:: ChangeBarValuesExample
434431
:save_last_frame:
435432

manim/mobject/graphing/scale.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ def __init__(self, base: float = 10, custom_labels: bool = True):
126126
127127
Examples
128128
--------
129-
130129
.. code-block:: python
131130
132131
func = ParametricFunction(lambda x: x, scaling=LogBase(base=2))
@@ -159,7 +158,6 @@ def get_custom_labels(
159158
160159
Parameters
161160
----------
162-
163161
val_range
164162
The iterable of values used to create the labels. Determines the exponent.
165163
unit_decimal_places

0 commit comments

Comments
 (0)