Use shape diagnostic function to display all shapes in the docs

stefmolin · stefmolin · commit 0a08393de79d · 2025-10-26T17:38:29.000-03:00
diff --git a/src/data_morph/shapes/circles/bullseye.py b/src/data_morph/shapes/circles/bullseye.py
@@ -22,9 +22,12 @@ class Bullseye(Rings):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.circles import Bullseye
 
-        _ = Bullseye(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Bullseye(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     See Also
     --------
diff --git a/src/data_morph/shapes/circles/circle.py b/src/data_morph/shapes/circles/circle.py
@@ -28,9 +28,12 @@ class Circle(Shape):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.circles import Circle
 
-        _ = Circle(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Circle(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/circles/rings.py b/src/data_morph/shapes/circles/rings.py
@@ -28,9 +28,12 @@ class Rings(Shape):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.circles import Rings
 
-        _ = Rings(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Rings(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/diamond.py b/src/data_morph/shapes/lines/diamond.py
@@ -13,11 +13,13 @@ class Diamond(LineCollection):
        :caption:
             This shape is generated using the panda dataset.
 
-        import matplotlib.pyplot as plt
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import Diamond
 
-        _ = Diamond(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Diamond(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/high_lines.py b/src/data_morph/shapes/lines/high_lines.py
@@ -14,9 +14,12 @@ class HighLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import HighLines
 
-        _ = HighLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = HighLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/horizontal_lines.py b/src/data_morph/shapes/lines/horizontal_lines.py
@@ -16,9 +16,12 @@ class HorizontalLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import HorizontalLines
 
-        _ = HorizontalLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = HorizontalLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/rectangle.py b/src/data_morph/shapes/lines/rectangle.py
@@ -13,11 +13,13 @@ class Rectangle(LineCollection):
        :caption:
             This shape is generated using the panda dataset.
 
-        import matplotlib.pyplot as plt
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import Rectangle
 
-        _ = Rectangle(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Rectangle(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/slant_down.py b/src/data_morph/shapes/lines/slant_down.py
@@ -14,9 +14,12 @@ class SlantDownLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import SlantDownLines
 
-        _ = SlantDownLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = SlantDownLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/slant_up.py b/src/data_morph/shapes/lines/slant_up.py
@@ -14,9 +14,12 @@ class SlantUpLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import SlantUpLines
 
-        _ = SlantUpLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = SlantUpLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/star.py b/src/data_morph/shapes/lines/star.py
@@ -15,11 +15,13 @@ class Star(LineCollection):
        :caption:
             This shape is generated using the panda dataset.
 
-        import matplotlib.pyplot as plt
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import Star
 
-        _ = Star(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Star(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/vertical_lines.py b/src/data_morph/shapes/lines/vertical_lines.py
@@ -16,9 +16,12 @@ class VerticalLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import VerticalLines
 
-        _ = VerticalLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = VerticalLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/wide_lines.py b/src/data_morph/shapes/lines/wide_lines.py
@@ -14,9 +14,12 @@ class WideLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import WideLines
 
-        _ = WideLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = WideLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/lines/x_lines.py b/src/data_morph/shapes/lines/x_lines.py
@@ -14,9 +14,12 @@ class XLines(LineCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.lines import XLines
 
-        _ = XLines(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = XLines(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/club.py b/src/data_morph/shapes/points/club.py
@@ -18,9 +18,12 @@ class Club(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import Club
 
-        _ = Club(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Club(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/dots_grid.py b/src/data_morph/shapes/points/dots_grid.py
@@ -16,9 +16,12 @@ class DotsGrid(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import DotsGrid
 
-        _ = DotsGrid(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = DotsGrid(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.1)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/figure_eight.py b/src/data_morph/shapes/points/figure_eight.py
@@ -16,9 +16,12 @@ class FigureEight(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import FigureEight
 
-        _ = FigureEight(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = FigureEight(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
@@ -30,7 +33,23 @@ class FigureEight(PointCollection):
     Notes
     -----
     This shape uses the formula for the `Lemniscate of Bernoulli
-    <https://en.wikipedia.org/wiki/Lemniscate_of_Bernoulli>`_.
+    <https://en.wikipedia.org/wiki/Lemniscate_of_Bernoulli>`_. It will orient itself
+    vertically or horizontally depending on which direction has a larger range in the
+    input dataset. For example, the panda dataset used above resulted in a horizontal
+    orientation, but the music dataset results in a vertical orientation:
+
+    .. plot::
+       :scale: 75
+       :caption:
+            This shape is generated using the music dataset.
+
+        from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
+        from data_morph.shapes.points import FigureEight
+
+        dataset = DataLoader.load_dataset('music')
+        shape = FigureEight(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.1)
     """
 
     name = 'figure_eight'
diff --git a/src/data_morph/shapes/points/heart.py b/src/data_morph/shapes/points/heart.py
@@ -16,9 +16,12 @@ class Heart(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import Heart
 
-        _ = Heart(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Heart(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/parabola.py b/src/data_morph/shapes/points/parabola.py
@@ -16,9 +16,12 @@ class DownParabola(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import DownParabola
 
-        _ = DownParabola(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = DownParabola(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
@@ -53,9 +56,12 @@ class LeftParabola(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import LeftParabola
 
-        _ = LeftParabola(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = LeftParabola(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
@@ -90,9 +96,12 @@ class RightParabola(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import RightParabola
 
-        _ = RightParabola(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = RightParabola(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
@@ -127,9 +136,12 @@ class UpParabola(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import UpParabola
 
-        _ = UpParabola(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = UpParabola(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/scatter.py b/src/data_morph/shapes/points/scatter.py
@@ -18,9 +18,12 @@ class Scatter(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import Scatter
 
-        _ = Scatter(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Scatter(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.1)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/spade.py b/src/data_morph/shapes/points/spade.py
@@ -19,9 +19,12 @@ class Spade(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import Spade
 
-        _ = Spade(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Spade(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)
 
     Parameters
     ----------
diff --git a/src/data_morph/shapes/points/spiral.py b/src/data_morph/shapes/points/spiral.py
@@ -16,9 +16,12 @@ class Spiral(PointCollection):
             This shape is generated using the panda dataset.
 
         from data_morph.data.loader import DataLoader
+        from data_morph.plotting.diagnostics import plot_shape_on_dataset
         from data_morph.shapes.points import Spiral
 
-        _ = Spiral(DataLoader.load_dataset('panda')).plot()
+        dataset = DataLoader.load_dataset('panda')
+        shape = Spiral(dataset)
+        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.15)
 
     Parameters
     ----------
