Skip to content
This repository was archived by the owner on Aug 15, 2019. It is now read-only.

Commit 393e833

Browse files
committed
improve the docstrings for polar co-ordinates
1 parent 5eb36c0 commit 393e833

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

robot/markers.py

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,37 +65,44 @@ def __init__(self, rot, dist_m):
6565
@property
6666
def rot_x_rad(self) -> Radians:
6767
"""
68-
Rotation of marker relative to camera in the #TODO axis.
68+
Rotation of marker around the x axis relative to camera in radians.
69+
70+
A positive angle represents a marker above the centre of the camera's vision.
6971
"""
7072
return self._rot_x_rad
7173

7274
@property
7375
def rot_y_rad(self) -> Radians:
7476
"""
75-
Rotation of marker relative to camera in the #TODO axis.
77+
Rotation of marker around the y axis relative to camera in radians.
78+
79+
A positive angle represents a marker to the right of the centre of the
80+
camera's vision.
7681
"""
7782
return self._rot_y_rad
7883

7984
@property
8085
def rot_x_deg(self) -> Degrees:
8186
"""
82-
Rotation of marker relative to camera in the #TODO axis.
87+
Rotation of marker around the x axis relative to camera in degrees.
88+
89+
A positive angle represents a marker above the centre of the camera's vision.
8390
"""
84-
# TODO describe which axis this is
8591
return Degrees(math.degrees(self._rot_x_rad))
8692

8793
@property
8894
def rot_y_deg(self) -> Degrees:
8995
"""
90-
Rotation of marker relative to camera in the #TODO axis.
96+
Rotation of marker around the y axis relative to camera in degrees.
97+
98+
A positive angle represents a marker to the right of the centre of the
99+
camera's vision.
91100
"""
92-
# TODO describe which axis this is
93101
return Degrees(math.degrees(self._rot_y_rad))
94102

95103
@property
96104
def distance_metres(self) -> Metres:
97105
"""Distance of marker from camera in metres."""
98-
# TODO describe which axis this is
99106
return self._distance_metres
100107

101108

0 commit comments

Comments
 (0)