Merge branch 'main' into max_arg

Author: ad-chaos

manim/mobject/geometry/polygram.py

@@ -62,8 +62,6 @@ def construct(self):
                 self.play(MoveAlongPath(dot, hexagram), run_time=5, rate_func=linear)
                 self.remove(dot)
                 self.wait()
-
-
     """
 
     def __init__(self, *vertex_groups: Iterable[Sequence[float]], color=BLUE, **kwargs):
@@ -143,9 +141,12 @@ def round_corners(self, radius: float = 0.5):
         radius
             The curvature of the corners of the :class:`Polygram`.
 
+
+        .. seealso::
+            :class:`.~RoundedRectangle`
+
         Examples
         --------
-
         .. manim:: PolygramRoundCorners
             :save_last_frame:
 
@@ -159,10 +160,6 @@ def construct(self):
 
                     shapes.arrange(RIGHT)
                     self.add(shapes)
-
-        See Also
-        --------
-        :class:`RoundedRectangle`
         """
 
         if radius == 0:
@@ -228,7 +225,6 @@ class Polygon(Polygram):
 
     Examples
     --------
-
     .. manim:: PolygonExample
         :save_last_frame:
 
@@ -354,7 +350,6 @@ class RegularPolygon(RegularPolygram):
 
     Examples
     --------
-
     .. manim:: RegularPolygonExample
         :save_last_frame:
 
@@ -488,7 +483,6 @@ class Triangle(RegularPolygon):
 
     Examples
     --------
-
     .. manim:: TriangleExample
         :save_last_frame:
 
@@ -528,7 +522,6 @@ class Rectangle(Polygon):
 
     Examples
     ----------
-
     .. manim:: RectangleExample
         :save_last_frame:
 
@@ -600,7 +593,6 @@ class Square(Rectangle):
 
     Examples
     --------
-
     .. manim:: SquareExample
         :save_last_frame:
 
@@ -629,7 +621,6 @@ class RoundedRectangle(Rectangle):
 
     Examples
     --------
-
     .. manim:: RoundedRectangleExample
         :save_last_frame:
 
@@ -651,12 +642,6 @@ def __init__(self, corner_radius=0.5, **kwargs):
 class Cutout(VMobject, metaclass=ConvertToOpenGL):
     """A shape with smaller cutouts.
 
-    .. warning::
-
-        Technically, this class behaves similar to a symmetric difference: if
-        parts of the ``mobjects`` are not located within the ``main_shape``,
-        these parts will be added to the resulting :class:`~.VMobject`.
-
     Parameters
     ----------
     main_shape : :class:`~.VMobject`
@@ -667,6 +652,12 @@ class Cutout(VMobject, metaclass=ConvertToOpenGL):
         Further keyword arguments that are passed to the constructor of
         :class:`~.VMobject`.
 
+
+    .. warning::
+        Technically, this class behaves similar to a symmetric difference: if
+        parts of the ``mobjects`` are not located within the ``main_shape``,
+        these parts will be added to the resulting :class:`~.VMobject`.
+
     Examples
     --------
     .. manim:: CutoutExample

manim/mobject/geometry/shape_matchers.py

@@ -18,7 +18,6 @@ class SurroundingRectangle(RoundedRectangle):
 
     Examples
     --------
-
     .. manim:: SurroundingRectExample
         :save_last_frame:
 
@@ -58,7 +57,6 @@ class BackgroundRectangle(SurroundingRectangle):
 
     Examples
     --------
-
     .. manim:: ExampleBackgroundRectangle
         :save_last_frame:
 

manim/mobject/geometry/tips.py

@@ -23,14 +23,13 @@
 class ArrowTip(VMobject, metaclass=ConvertToOpenGL):
     r"""Base class for arrow tips.
 
-    See Also
-    --------
-    :class:`ArrowTriangleTip`
-    :class:`ArrowTriangleFilledTip`
-    :class:`ArrowCircleTip`
-    :class:`ArrowCircleFilledTip`
-    :class:`ArrowSquareTip`
-    :class:`ArrowSquareFilledTip`
+    .. seealso::
+        :class:`ArrowTriangleTip`
+        :class:`ArrowTriangleFilledTip`
+        :class:`ArrowCircleTip`
+        :class:`ArrowCircleFilledTip`
+        :class:`ArrowSquareTip`
+        :class:`ArrowSquareFilledTip`
 
     Examples
     --------

manim/mobject/graphing/functions.py

@@ -39,7 +39,6 @@ class ParametricFunction(VMobject, metaclass=ConvertToOpenGL):
 
     Examples
     --------
-
     .. manim:: PlotParametricFunction
         :save_last_frame:
 

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 @@ def construct(self):
 
                 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 @@ def add_numbers(
             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()

manim/mobject/graphing/probability.py

@@ -38,7 +38,6 @@ class SampleSpace(Rectangle):
 
     Examples
     --------
-
     .. manim:: ExampleSampleSpace
         :save_last_frame:
 
@@ -398,7 +397,6 @@ def construct(self):
                     )
 
                     self.add(chart, c_bar_lbls)
-
         """
 
         bar_labels = VGroup()
@@ -429,7 +427,6 @@ def change_bar_values(self, values: Iterable[float]):
 
         Examples
         --------
-
         .. manim:: ChangeBarValuesExample
             :save_last_frame:
 

manim/mobject/graphing/scale.py

@@ -126,7 +126,6 @@ def __init__(self, base: float = 10, custom_labels: bool = True):
 
         Examples
         --------
-
         .. code-block:: python
 
             func = ParametricFunction(lambda x: x, scaling=LogBase(base=2))
@@ -159,7 +158,6 @@ def get_custom_labels(
 
         Parameters
         ----------
-
         val_range
             The iterable of values used to create the labels. Determines the exponent.
         unit_decimal_places