Documentation copy edit

Author: grega

buildhat/color.py

@@ -20,7 +20,7 @@ def __init__(self, port):
         self._old_color = None
 
     def segment_color(self, r, g, b):
-        """Returns the color name from HSV
+        """Returns the color name from RGB
 
         :return: Name of the color as a string
         :rtype: str

buildhat/devices.py

@@ -68,7 +68,7 @@ def _hat(self):
 
     @property
     def name(self):
-        """Determine name of device on port"""
+        """Determines name of device on port"""
         if self.connected == False:
             return "No device"
         elif self.typeidcur in self._device_names:

buildhat/distance.py

@@ -101,7 +101,7 @@ def when_out_of_range(self, value):
         self.callback(self._intermediate)
 
     def wait_for_out_of_range(self, distance):
-        """Waits until distance is farther than specified distance
+        """Waits until object is farther than specified distance
 
         :param distance: Distance
         """
@@ -112,7 +112,7 @@ def wait_for_out_of_range(self, distance):
                 self._cond_data.wait()
 
     def wait_for_in_range(self, distance):
-        """Waits until distance is closer than specified distance
+        """Waits until object is closer than specified distance
 
         :param distance: Distance
         """
@@ -126,7 +126,7 @@ def eyes(self, *args):
         """
         Brightness of LEDs on sensor
 
-        :param \*args: Four Brightness arguments of 0 to 100
+        :param \*args: Four brightness arguments of 0 to 100
         """
         out = [0xc5]
         if len(args) != 4:

buildhat/force.py

@@ -49,9 +49,9 @@ def threshold_force(self, value):
         self._threshold_force = value
 
     def get_force(self):
-        """Returns the force in newtons
+        """Returns the force in (N)
 
-        :return: The force exherted on the button
+        :return: The force exerted on the button
         :rtype: int
         """
         return self.get()[0]

buildhat/matrix.py

@@ -7,20 +7,20 @@ class Matrix(Device):
     """LED Matrix
 
     :param port: Port of device
-    :raises DeviceInvalid: Occurs if there is no led matrix attached to port
+    :raises DeviceInvalid: Occurs if there is no LED matrix attached to port
     """
     def __init__(self, port):
         super().__init__(port)
         if self.typeid != 64:
-            raise DeviceInvalid('There is not a led matrix connected to port %s (Found %s)' % (port, self.name))
+            raise DeviceInvalid('There is no LED matrix connected to port %s (Found %s)' % (port, self.name))
         self.on()
         self.mode(2)
         self._matrix = [[(0,0) for x in range(3)] for y in range(3)]
 
     def set_pixels(self, matrix):
         """Write pixel data to LED matrix
 
-        :param pixels: 3x3 list of tuples, with color (0-9) and brightness (0-10) (see example for more detail)
+        :param pixels: 3x3 list of tuples, with colour (0–9) and brightness (0–10) (see example for more detail)
         """
         for x in range(3):
             for y in range(3):
@@ -65,7 +65,7 @@ def strtocolor(self, colorstr):
     def clear(self, pixel=None):
         """Clear matrix or set all as the same pixel
 
-        :param pixel: tuple of color (0-9) or string and brightness (0-10)
+        :param pixel: tuple of colour (0–9) or string and brightness (0–10)
         """
         if pixel is None:
             self._matrix = [[(0,0) for x in range(3)] for y in range(3)]
@@ -89,7 +89,7 @@ def set_pixel(self, coord, pixel, display=True):
         """Write pixel to coordinate
 
         :param coord: (0,0) to (2,2)
-        :param pixel: tuple of color (0-9) or string and brightness (0-10)
+        :param pixel: tuple of colour (0–9) or string and brightness (0–10)
         :param display: Whether to update matrix or not
         """
         if isinstance(pixel, tuple):

buildhat/motors.py

@@ -183,7 +183,7 @@ def stop(self):
         self.coast()
 
     def get_position(self):
-        """Gets position of motor with relation to preset position (can be negative or positive).
+        """Gets position of motor with relation to preset position (can be negative or positive)
 
         :return: Position of motor
         :rtype: int
@@ -209,7 +209,7 @@ def get_speed(self):
     @property
     def when_rotated(self):
         """
-        Handles rotatation events
+        Handles rotation events
 
         :getter: Returns function to be called when rotated
         :setter: Sets function to be called when rotated

docs/buildhat/colorsensor.rst

@@ -5,10 +5,10 @@ ColorSensor
 
 .. |location_link| raw:: html
 
-   <a href="https://education.lego.com/en-gb/products/lego-technic-color-sensor/45605" target="_blank">LEGO Colour Sensor 45605</a>
+   <a href="https://education.lego.com/en-gb/products/lego-technic-color-sensor/45605" target="_blank">LEGO Color Sensor 45605</a>
 
 
-The LEGO® Education SPIKE™ Colour sensor can sort between 8 different colours and can measure reflected and ambient or natural light. 
+The LEGO® Education SPIKE™ Color Sensor can sort between eight different colors and can measure reflected and ambient or natural light. 
 
 .. autoclass:: buildhat.ColorSensor
    :members:

docs/buildhat/distancesensor.rst

@@ -8,7 +8,7 @@ DistanceSensor
    <a href="https://education.lego.com/en-gb/products/lego-technic-distance-sensor/45604" target="_blank">LEGO Distance Sensor 45604</a>
 
 
-The LEGO® Education SPIKE™ Colour sensor behaves like a conventional ultrasonic range finder but also has 4 LEDs that can be used to create the "eyes" of a robot. Each LED can be controlled individually.
+The LEGO® Education SPIKE™ Distance Sensor behaves like a conventional ultrasonic range finder but also has four LEDs that can be used to create the "eyes" of a robot. Each LED can be controlled individually.
 
 .. autoclass:: buildhat.DistanceSensor
    :members:

docs/buildhat/forcesensor.rst

@@ -8,7 +8,7 @@ ForceSensor
    <a href="https://education.lego.com/en-gb/products/lego-technic-force-sensor-by-lego-education/45606" target="_blank">LEGO® Force Sensor Set 45606e</a>
 
 
-The LEGO® Education SPIKE™ Prime Force Sensor (also known as the LEGO® Technic Force Sensor) can measure pressure of up to 10 Newtons, but it can also be used as a touch sensor or a simple button.
+The LEGO® Education SPIKE™ Prime Force Sensor (also known as the LEGO® Technic Force Sensor) can measure pressure of up to 10 newtons (N), but it can also be used as a touch sensor or a simple button.
 
 
 .. autoclass:: buildhat.ForceSensor

docs/buildhat/index.rst

@@ -4,7 +4,7 @@ Library
 =======
 
 The Build HAT library has been created to support the Raspberry Pi Build HAT, 
-an add-on board for the Raspberry Pi computer which allows control of up to 4 LEGO® Technic™ motors and sensors included in the SPIKE™ Portfolio.
+an add-on board for the Raspberry Pi computer, which allows control of up to four LEGO® Technic™ motors and sensors included in the SPIKE™ Portfolio.
 
 .. image:: images/BuildHAT_closeup.jpg
    :width: 300
@@ -17,7 +17,7 @@ Other LEGO® devices may be supported if they use the LPF2 connector:
    :width: 100
    :alt: The LEGO LPF2 connector
 
-In order to drive motors, your Raspberry Pi and Build HAT will need an external 7.5v
+In order to drive motors, your Raspberry Pi and Build HAT will need an external 7.5V
 power supply. For best results, use the official Raspberry Pi Build HAT power supply. 
 
 .. warning::

docs/buildhat/matrix.rst

@@ -1,7 +1,7 @@
 Matrix
 ======
 
-The Spike 3x3 LED matrix has individual elements that can be set individually or as a whole.
+The LEGO® SPIKE™ 3x3 LED matrix has individual elements that can be set individually or as a whole.
 
 Colours may be passed as string or integer parameters. 
 

docs/buildhat/motor.rst

@@ -1,9 +1,8 @@
 Motor
 =====
 
-Motors from he LEGO® Education SPIKE™ portfolio have an integrated rotation sensor (encoder) and can be positioned 1-degree accuracy. The encoders which can be queried to find the current 
-position of the motor with respect to a 'zero' mark shown on the motor itself. Other motors 
-without encodes will report a 0 value if queried.
+LEGO® Technic™ motors from the LEGO® Education SPIKE™ portfolio have an integrated rotation sensor (encoder) and can be positioned with 1-degree accuracy. The encoders can be queried to find the current 
+position of the motor with respect to a 'zero' mark shown on the motor itself. Other motors without encoders will report a 0 value if queried.
 
 |location_link1|