added entries in stubs, resolve docu issues

Author: Johann Krauter

galleries/examples/shapes_and_collections/ellipse_arrow.py

@@ -16,31 +16,26 @@
 
 
 # Create a figure and axis
-fig, ax = plt.subplots(1, 1, subplot_kw={"aspect": "equal"})
+fig, ax = plt.subplots(subplot_kw={"aspect": "equal"})
 
 # Define an ellipse clockwise
-center = (2, 4)
-width = 30
-height = 20
-angle = 35
-ellipse_clockwise = Ellipse(
+center=(2, 4)
+width=30
+height=20
+angle=35
+ellipse = Ellipse(
     xy=center,
     width=width,
     height=height,
     angle=angle,
     facecolor="none",
-    edgecolor="b",
-    label="clockwise"
+    edgecolor="b"
 )
-
-# Get position of vertex for arrow marker
-vertices = ellipse_clockwise.get_co_vertices()
-
-# Add the ellipse patch to the axis
-ax.add_patch(ellipse_clockwise)
+ax.add_patch(ellipse)
 
 # Plot a arrow marker at the end point of minor axis
-t = Affine2D().rotate_deg(ellipse_clockwise.angle)
+vertices = ellipse.get_co_vertices()
+t = Affine2D().rotate_deg(ellipse.angle)
 ax.plot(
     vertices[0][0],
     vertices[0][1],
@@ -49,54 +44,8 @@
     markersize=10
 )
 
-# Define an second ellipse counterclockwise
-center = (2, 4)
-width = 30
-height = 15
-angle = -20
-ellipse_counterclockwise = Ellipse(
-    xy=center,
-    width=width,
-    height=height,
-    angle=angle,
-    facecolor="none",
-    edgecolor="g",
-    label="counterclockwise"
-)
-
-# Add the ellipse patch to the axis
-ax.add_patch(ellipse_counterclockwise)
-
-# Get position of vertex for arrow marker
-vertices = ellipse_counterclockwise.get_co_vertices()
-
-# Plot a arrow marker at the end point of minor axis
-t = Affine2D().rotate_deg(ellipse_counterclockwise.angle)
-ax.plot(
-    vertices[0][0],
-    vertices[0][1],
-    color="g",
-    marker=MarkerStyle("<", "full", t),
-    markersize=10
-)
-
-
-plt.legend()
 plt.show()
 
-center = (2, 4)
-width = 30
-height = 20
-angle = 35
-ellipse = Ellipse(
-    xy=center,
-    width=width,
-    height=height,
-    angle=angle
-)
-print(ellipse.get_vertices())
-print(ellipse.get_co_vertices())
-
 # %%
 #
 # .. admonition:: References

lib/matplotlib/patches.py

@@ -1658,7 +1658,7 @@ def get_vertices(self):
         """
         Return the left and right vertex coordinates of the ellipse.
 
-        The definition can be found `here<https://en.wikipedia.org/wiki/Ellipse>`_
+        The definition can be found `here <https://en.wikipedia.org/wiki/Ellipse>`_
         """
         x0 = self._center[0] - self._width / 2 * np.cos(np.deg2rad(self._angle))
         y0 = self._center[1] - self._width / 2 * np.sin(np.deg2rad(self._angle))
@@ -1670,7 +1670,7 @@ def get_co_vertices(self):
         """
         Return the left and right co-vertex coordinates of the ellipse.
 
-        The definition can be found `here<https://en.wikipedia.org/wiki/Ellipse>`_
+        The definition can be found `here <https://en.wikipedia.org/wiki/Ellipse>`_
         """
         x0 = self._center[0] - self._height / 2 * np.sin(np.deg2rad(self._angle))
         y0 = self._center[1] + self._height / 2 * np.cos(np.deg2rad(self._angle))

lib/matplotlib/patches.pyi

@@ -258,6 +258,9 @@ class Ellipse(Patch):
     angle = property(get_angle, set_angle)
 
     def get_corners(self) -> np.ndarray: ...
+    
+    def get_vertices(self) -> list[float, float]: ...
+    def get_co_vertices(self) -> list[float, float]: ...
 
 class Annulus(Patch):
     a: float