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

Commit 1cf8800

Browse files
committed
replace legacy polar docstrings with Deprecated
1 parent 393e833 commit 1cf8800

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

robot/markers.py

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -64,45 +64,27 @@ def __init__(self, rot, dist_m):
6464
# TODO add tests for all these
6565
@property
6666
def rot_x_rad(self) -> Radians:
67-
"""
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.
71-
"""
67+
"""Deprecated. Use Spherical Coordinates instead."""
7268
return self._rot_x_rad
7369

7470
@property
7571
def rot_y_rad(self) -> Radians:
76-
"""
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.
81-
"""
72+
"""Deprecated. Use Spherical Coordinates instead."""
8273
return self._rot_y_rad
8374

8475
@property
8576
def rot_x_deg(self) -> Degrees:
86-
"""
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.
90-
"""
77+
"""Deprecated. Use Spherical Coordinates instead."""
9178
return Degrees(math.degrees(self._rot_x_rad))
9279

9380
@property
9481
def rot_y_deg(self) -> Degrees:
95-
"""
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.
100-
"""
82+
"""Deprecated. Use Spherical Coordinates instead."""
10183
return Degrees(math.degrees(self._rot_y_rad))
10284

10385
@property
10486
def distance_metres(self) -> Metres:
105-
"""Distance of marker from camera in metres."""
87+
"""Deprecated. Use Spherical Coordinates instead."""
10688
return self._distance_metres
10789

10890

0 commit comments

Comments
 (0)