Skip to content

Commit c7413d7

Browse files
committed
STY
1 parent 29c70dc commit c7413d7

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

refellips/objectiveSE.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ def circular_distance(angle1, angle2, period=2 * np.pi):
2222
"""
2323
Calculates the circular distance between two angles.
2424
25-
Args:
26-
angle1 (float or np.ndarray): The first angle(s) in radians.
27-
angle2 (float or np.ndarray): The second angle(s) in radians.
28-
period (float): The period of the circular domain (e.g., 2*np.pi for full circle).
25+
Parameters
26+
----------
27+
angle1 : float, np.ndarray
28+
First angle
29+
angle2 : float, np.ndarray
30+
Second angle
31+
period : float
32+
The period of the circular domain (e.g., 2*np.pi for full circle).
2933
3034
Returns:
3135
float or np.ndarray: The shortest circular distance between the angles.

0 commit comments

Comments
 (0)