rename safe_heading to heading_name and re-instate the parameter (#43)

* rename safe_heading to heading_name and re-instate the parameter

* rename from heading_name to convert_heading

* add punctuation

* fix - change name of method in library description section

Author: CleoQc

Python/di_sensors/easy_inertial_measurement_unit.py

@@ -138,10 +138,10 @@ def safe_calibration_status(self):
             ifMutexRelease(self.use_mutex)
         return status
 
-    def safe_heading(self):
+    def convert_heading(self, in_heading):
         """
-        Determines the heading of the sensor (robot).
-        This function doesn't take into account the declination.
+        This method takes in a heading in degrees and return the name of the corresponding heading.
+        :param float in_heading: the value in degree that needs to be converted to a string.
 
         :return: The heading of the sensor as a string.
         :rtype: str
@@ -156,7 +156,6 @@ def safe_heading(self):
 
         """
 
-        in_heading = self.safe_north_point()
         headings = ["North", "North East",
                     "East", "South East",
                     "South", "South West",

docs/source/structure.rst

@@ -144,7 +144,7 @@ Easy - IMU
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.reconfig_bus
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_calibrate
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_calibration_status
-   di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_heading
+   di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.convert_heading
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_read_euler
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_read_magnetometer
    di_sensors.easy_inertial_measurement_unit.EasyIMUSensor.safe_north_point