Skip to content

Commit

Permalink
Minor Improvement in docstring style.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mayitzin committed Feb 1, 2022
1 parent f67a1e1 commit a94eaef
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions ahrs/common/orientation.py
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ def dcm2quat(R: np.ndarray) -> np.ndarray:
def rpy2q(angles: np.ndarray, in_deg: bool = False) -> np.ndarray:
"""
Quaternion from roll-pitch-yaw angles
Roll is the first rotation (about X-axis), pitch is the second rotation
(about Y-axis), and yaw is the last rotation (about Z-axis.)
Expand Down Expand Up @@ -747,7 +747,7 @@ def rpy2q(angles: np.ndarray, in_deg: bool = False) -> np.ndarray:
return q

def cardan2q(angles: np.ndarray, in_deg: bool = False) -> np.ndarray:
"""synonym to function :func:`rpy2q`."""
"""Synonym to function :func:`rpy2q`."""
return rpy2q(angles, in_deg=in_deg)

def q2rpy(q: np.ndarray, in_deg: bool = False) -> np.ndarray:
Expand Down Expand Up @@ -780,7 +780,7 @@ def q2rpy(q: np.ndarray, in_deg: bool = False) -> np.ndarray:
return angles

def q2cardan(q: np.ndarray, in_deg: bool = False) -> np.ndarray:
"""synonym to function :func:`q2rpy`."""
"""Synonym to function :func:`q2rpy`."""
return q2rpy(q, in_deg=in_deg)

def ecompass(a: np.ndarray, m: np.ndarray, frame: str = 'ENU', representation: str = 'rotmat') -> np.ndarray:
Expand Down

0 comments on commit a94eaef

Please sign in to comment.