Fix @philipbl knitpick

Author: christopolise

broadcasters/__init__.py

@@ -7,6 +7,13 @@
 
 
 def start_outputs(system_queue, demo_output_queue):
+    """
+    Start the output processing.
+
+    Args:
+        system_queue (Queue): The system queue.
+        demo_output_queue (Queue): The demo output queue.
+    """
     try:
         logger.info("Loading MQTT output...")
         from . import mqtt

broadcasters/mqtt.py

@@ -15,7 +15,8 @@ def start_processing_output(system_queue, mqtt_q):
     """
 
     def on_connect(client, userdata, flags, rc):
-        """Callback function executed upon the successful connection to the desired broker
+        """
+        Callback function executed upon the successful connection to the desired broker
 
         Args:
             client (mqtt.Client): The client instance for this callback
@@ -26,7 +27,8 @@ def on_connect(client, userdata, flags, rc):
         logger.info("MQTT Client connected ({})", rc)
 
     def on_disconnect(client, userdata, rc):
-        """Callback function executed upon disconnecting from the broker
+        """
+        Callback function executed upon disconnecting from the broker
 
         Args:
             client (mqtt.Client): The client instance for this callback
@@ -51,7 +53,8 @@ def on_disconnect(client, userdata, rc):
     client.on_disconnect = on_disconnect
 
     def process():
-        """Contains generator which fetches all messages from the `byu_sss/output` topic on broker
+        """
+        Contains generator which fetches all messages from the `byu_sss/output` topic on broker
 
         Returns:
             Generator: Generator that fetches all messages from the `byu_sss/output` topic on broker

controllers/__init__.py

@@ -2,6 +2,13 @@
 
 
 def start_inputs(system_queue, demo_input_queue):
+    """
+    Start the input processing.
+
+    Args:
+        system_queue (Queue): The system queue.
+        demo_input_queue (Queue): The demo input queue.
+    """
     try:
         logger.info("Loading MQTT input...")
         from . import mqtt

controllers/gamepad.py

@@ -44,7 +44,8 @@ def start_processing_input(system_queue, demo_input_queue):
     thread.start()
 
     def process():
-        """Contains generator which fetches all messages from the `byu_sss/output` topic on broker
+        """
+        Contains generator which fetches all messages from the `byu_sss/output` topic on broker
 
         Returns:
             Generator: Generator that fetches all messages from the `byu_sss/output` topic on broker

controllers/keyboard.py

@@ -18,6 +18,12 @@
 
 
 def check_if_sim():
+    """
+    Check if the program is running in simulator mode.
+
+    Returns:
+        bool: True if running in simulator mode, False otherwise.
+    """
     try:
         pygame.event.get()
         return True

controllers/mqtt.py

@@ -16,7 +16,8 @@ def start_processing_input(system_queue, demo_input_queue):
     """
 
     def on_message(client, userdata, message):
-        """Callback function executed upon receiving a message from the broker
+        """
+        Callback function executed upon receiving a message from the broker
 
         Args:
             client (mqtt.Client): The client instance for this callback
@@ -44,7 +45,8 @@ def on_message(client, userdata, message):
             logger.error("MQTT message did not have correct keys.")
 
     def on_connect(client, userdata, flags, rc):
-        """Callback function executed upon the successful connection to the desired broker
+        """
+        Callback function executed upon the successful connection to the desired broker
 
         Args:
             client (mqtt.Client): The client instance for this callback
@@ -59,7 +61,8 @@ def on_connect(client, userdata, flags, rc):
         client.subscribe("byu_sss/input")
 
     def on_disconnect(client, userdata, rc):
-        """Callback function executed upon disconnecting from the broker
+        """
+        Callback function executed upon disconnecting from the broker
 
         Args:
             client (mqtt.Client): The client instance for this callback
@@ -85,11 +88,11 @@ def on_disconnect(client, userdata, rc):
     client.on_disconnect = on_disconnect
 
     def process():
-        """Contains generator which fetches all messages from the `byu_sss/input` topic on broker
+        """
+        Contains generator which fetches all messages from the `byu_sss/input` topic on broker
 
         Returns:
             Generator: Generator that fetches all messages from the `byu_sss/input` topic on broker
-
         """
         logger.debug("In process func")
         while True:

demos/autotype/main.py

@@ -10,7 +10,8 @@ class Autotype:
     # Game output is passed through output_queue
     # Screen updates are done through the screen object
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): Queue for user input
@@ -89,7 +90,8 @@ def stop(self):
         pass
 
     def get_input_buff(self):
-        """Return the input buffer"
+        """
+        Return the input buffer
 
         Returns:
             list: List of input buffer

demos/breakout/main.py

@@ -25,7 +25,8 @@ class Breakout:
     # Game output is passed through output_queue
     # Screen updates are done through the screen object
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): Input queue
@@ -285,7 +286,8 @@ def stop(self):
         self.gameover = True
 
     def init_screen(self, screen):
-        """Initialize the screen with the game elements
+        """
+        Initialize the screen with the game elements
 
         Args:
             screen (Screen): The Screen object to draw on
@@ -344,7 +346,8 @@ def level_up(self):
         return True
 
     def get_angle(self, paddle):
-        """Get the angle of the ball based on the paddle position
+        """
+        Get the angle of the ball based on the paddle position
 
         Args:
             paddle (list): The paddle position
@@ -362,7 +365,8 @@ def get_angle(self, paddle):
         return spin, is_left
 
     def ball_travel(self, is_left, is_down, spin, screen):
-        """Move the ball based on the angle and direction
+        """
+        Move the ball based on the angle and direction
 
         Args:
             is_left (bool): The direction of the ball

demos/breakout_ai/main.py

@@ -26,7 +26,8 @@ class BreakoutAi:
     # Screen updates are done through the screen object
 
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): Input queue
@@ -296,7 +297,8 @@ def stop(self):
         pass
 
     def init_screen(self, screen):
-        """Initialize the screen with the game elements
+        """
+        Initialize the screen with the game elements
 
         Args:
             screen (Screen): The Screen object to draw on
@@ -355,7 +357,8 @@ def level_up(self):
         return True
 
     def get_angle(self, paddle):
-        """Get the angle of the ball based on the paddle position
+        """
+        Get the angle of the ball based on the paddle position
 
         Args:
             paddle (list): The paddle position
@@ -373,7 +376,8 @@ def get_angle(self, paddle):
         return spin, is_left
 
     def ball_travel(self, is_left, is_down, spin, screen):
-        """Move the ball based on the angle and direction
+        """
+        Move the ball based on the angle and direction
 
         Args:
             is_left (bool): The direction of the ball
@@ -446,7 +450,8 @@ def ball_travel(self, is_left, is_down, spin, screen):
         return is_left, is_down
 
     def predict_ball_landing(self, is_left, is_down, spin, screen):
-        """Predict the x position where the ball will land
+        """
+        Predict the x position where the ball will land
 
         Args:
             is_left (bool): The direction of the ball

demos/camera/_main.py

@@ -18,7 +18,8 @@ class Camera_Source:
     """Object to hold the host and stream url of a camera source."""
 
     def __init__(self, host, stream):
-        """Constructor
+        """
+        Constructor
 
         Args:
             host (str): Host url of the camera
@@ -28,15 +29,17 @@ def __init__(self, host, stream):
         self.stream_url = stream
 
     def get_host(self):
-        """Gets the host url of the camera
+        """
+        Gets the host url of the camera
 
         Returns:
             str: Host url of the camera
         """
         return self.host_url
 
     def get_stream(self):
-        """Gets the stream url of the camera
+        """
+        Gets the stream url of the camera
 
         Returns:
             str: Stream url of the camera
@@ -53,7 +56,8 @@ class Camera:
     # Game output is passed through output_queue
     # Screen updates are done through the screen object
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): Queue to receive input from the user
@@ -314,5 +318,10 @@ def stop(self):
         pass
 
     def get_input_buff(self):
-        """Get all input off the queue"""
+        """
+        Get all input off the queue
+
+        Returns:
+            list: list of all inputs in the queue
+        """
         return list(self.input_queue.queue)

demos/cell/main.py

@@ -22,7 +22,8 @@ class Cell:
     demo_time = 30
 
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): The input queue
@@ -95,7 +96,8 @@ def run(self):
             count += 1
 
     def _map(self, x, in_min, in_max, out_min, out_max):
-        """Maps a value from one range to another
+        """
+        Maps a value from one range to another
 
         Args:
             x (float): The value to map

demos/checkerboard/main.py

@@ -7,7 +7,8 @@ class Checkerboard:
     # Game output is passed through output_queue
     # Screen updates are done through the screen object
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): The input queue

demos/circle/main.py

@@ -7,7 +7,8 @@ class Circle:
     # Game output is passed through output_queue
     # Screen updates are done through the screen object
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): The input queue

demos/cube/main.py

@@ -13,7 +13,8 @@ class Cube:
     demo_time = 30
 
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): The input queue

demos/digit_clock/main.py

@@ -9,7 +9,8 @@ class DigitClock:
     demo_time = 30
 
     def __init__(self, input_queue, output_queue, screen):
-        """Constructor
+        """
+        Constructor
 
         Args:
             input_queue (Queue): The input queue
@@ -32,7 +33,8 @@ def run(self):
         trace = Trace(self.screen)
 
         def draw_time(current_time, draw):
-            """Draw the current time on the screen
+            """
+            Draw the current time on the screen
 
             Args:
                 current_time (tuple): The current time