Merge pull request #82 from sourcebots/improve-polars

Improve the docstrings for polar co-ordinates

Author: kierdavis

robot/markers.py

@@ -64,38 +64,27 @@ def __init__(self, rot, dist_m):
     # TODO add tests for all these
     @property
     def rot_x_rad(self) -> Radians:
-        """
-        Rotation of marker relative to camera in the #TODO axis.
-        """
+        """Deprecated. Use Spherical Coordinates instead."""
         return self._rot_x_rad
 
     @property
     def rot_y_rad(self) -> Radians:
-        """
-        Rotation of marker relative to camera in the #TODO axis.
-        """
+        """Deprecated. Use Spherical Coordinates instead."""
         return self._rot_y_rad
 
     @property
     def rot_x_deg(self) -> Degrees:
-        """
-        Rotation of marker relative to camera in the #TODO axis.
-        """
-        # TODO describe which axis this is
+        """Deprecated. Use Spherical Coordinates instead."""
         return Degrees(math.degrees(self._rot_x_rad))
 
     @property
     def rot_y_deg(self) -> Degrees:
-        """
-        Rotation of marker relative to camera in the #TODO axis.
-        """
-        # TODO describe which axis this is
+        """Deprecated. Use Spherical Coordinates instead."""
         return Degrees(math.degrees(self._rot_y_rad))
 
     @property
     def distance_metres(self) -> Metres:
-        """Distance of marker from camera in metres."""
-        # TODO describe which axis this is
+        """Deprecated. Use Spherical Coordinates instead."""
         return self._distance_metres