Update classes.py

Author: ikostan

ellens-alien-game/classes.py

@@ -25,22 +25,58 @@ class Alien:
     total_aliens_created: int = 0
 
     def __init__(self, x_coordinate: int, y_coordinate: int):
+        """
+        Initialize a new Alien at the provided coordinates.
+
+        Sets health to 3, assigns x and y coordinates, and increments
+        Alien.total_aliens_created.
+
+        :param x_coordinate: Position on the x-axis.
+        :param y_coordinate: Position on the y-axis.
+        :return: None
+        """
         self.health: int = 3
         self.x_coordinate = x_coordinate
         self.y_coordinate = y_coordinate
         Alien.total_aliens_created += 1
 
     def is_alive(self):
+        """
+        Return whether the alien is alive.
+
+        :return: True if health > 0, else False.
+        """
         return self.health > 0
 
     def hit(self):
+        """
+        Decrement the alien's health by one point.
+
+        :return: None
+        """
         self.health -= 1
 
     def teleport(self, new_x_coordinate, new_y_coordinate):
+        """
+        Decrement the alien's health by one point.
+
+        :return: None
+        """
         self.x_coordinate = new_x_coordinate
         self.y_coordinate = new_y_coordinate
 
     def collision_detection(self, other):
+        """
+        Determine whether this Alien collides with another.
+
+        Implementation TBD; currently returns None.
+
+        :param other: Another Alien or object to check for
+                      positional overlap.
+        :return: None
+
+        `Source: /ellens-alien-game/classes_test.py`
+        """
         pass