add missing docs

Author: anton-ptashnik

godice/dice.py

@@ -97,6 +97,7 @@ async def pulse_led(self, pulse_count, on_time_ms, off_time_ms, rgb_tuple):
     async def get_color(self):
         """
         Read dice color
+        :returns: Color
         """
         self._color = self._color or await self._fetch_color()
         return self._color
@@ -111,6 +112,7 @@ async def _fetch_color(self):
     async def get_battery_level(self):
         """
         Read a battery level
+        :returns: int 0-100%
         """
         cmd_code = 3
         msg = bytearray([cmd_code])

godice/factory.py

@@ -34,6 +34,8 @@ class DiceShell(enum.Enum):
 def create(ble_client: bleak.BleakClient, dice_shell: DiceShell):
     """
     Creates Dice API object representing the specified type of a dice
+    :param ble_client: BleakClient
+    :param dice_shell: DiceShell
     """
     _dice = dice.Dice(ble_client)
     set_shell(_dice, dice_shell)
@@ -44,6 +46,8 @@ def set_shell(_dice: dice.Dice, dice_shell: DiceShell):
     """
     Change a dice shell.
     Should be called in order to receive correct number notifications corresponding to a newly set shell
+    :param dice: a Dice object to change a shell for
+    :param dice_shell: DiceShell
     """
     _xyzinterpret_fn = xyz_interpret_map[dice_shell]
     _dice._xyz_interpret_fn = _xyzinterpret_fn