Skip to content

Commit 0005c7e

Browse files
author
Johann Krauter
committed
changed function docstring to numpy style
1 parent 4ae516e commit 0005c7e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

galleries/examples/shapes_and_collections/ellipse_arrow.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,22 @@
1515
from matplotlib.transforms import Affine2D
1616

1717
import numpy as np
18+
1819
from typing import Tuple
1920

2021

2122
def getMinorMajor(ellipse: Ellipse) -> Tuple[list, list]:
22-
"""Calculates the end points of minor and major axis of an ellipse.
23+
"""
24+
Calculates the end points of minor and major axis of an ellipse.
2325
24-
Args:
25-
ellipse (Ellipse): Ellipse patch.
26+
Parameters
27+
----------
28+
ellipse : ~matplotlib.patches.Ellipse
29+
Ellipse patch.
2630
27-
Returns:
28-
Tuple[list, list]: Coordinates of minor end points and major end points.
31+
Returns
32+
-------
33+
~typing.Tuple[list, list]
2934
"""
3035
# Calculate the endpoints of the minor axis
3136
x0_minor = ellipse.center[0] - ellipse.height / 2 * np.sin(

0 commit comments

Comments
 (0)