chore: add documentation RI

Code functionality left unchanged, only added docs where missing

close: N25B-298

test/unit/test_main_receiver.py

@@ -7,11 +7,23 @@ from robot_interface.endpoints.main_receiver import MainReceiver
 
 @pytest.fixture
 def zmq_context():
+    """
+    A pytest fixture that creates and yields a ZMQ context.
+    
+    :return: An initialized ZeroMQ context.
+    :rtype: zmq.Context
+    """
     context = zmq.Context()
     yield context
 
 
 def test_handle_ping(zmq_context):
+    """
+    Tests the receiver's ability to handle the "ping" endpoint with data.
+
+    :param zmq_context: The ZeroMQ context fixture.
+    :type zmq_context: zmq.Context
+    """
     receiver = MainReceiver(zmq_context)
     response = receiver.handle_message({"endpoint": "ping", "data": "pong"})
 
@@ -22,6 +34,13 @@ def test_handle_ping(zmq_context):
 
 
 def test_handle_ping_none(zmq_context):
+    """
+    Tests the receiver's ability to handle the ping endpoint when the
+    data field is explicitly set to None.
+
+    :param zmq_context: The ZeroMQ context fixture.
+    :type zmq_context: zmq.Context
+    """
     receiver = MainReceiver(zmq_context)
     response = receiver.handle_message({"endpoint": "ping", "data": None})
 
@@ -33,6 +52,15 @@ def test_handle_ping_none(zmq_context):
 
 @mock.patch("robot_interface.endpoints.main_receiver.state")
 def test_handle_negotiate_ports(mock_state, zmq_context):
+    """
+    Tests the handling of the "negotiate/ports" endpoint.
+    
+    :param mock_state: Mocked global application state.
+    :type mock_state: mock.Mock
+
+    :param zmq_context: The ZeroMQ context fixture.
+    :type zmq_context: zmq.Context
+    """
     receiver = MainReceiver(zmq_context)
     mock_state.sockets = [receiver]
 
@@ -54,6 +82,13 @@ def test_handle_negotiate_ports(mock_state, zmq_context):
 
 
 def test_handle_unimplemented_endpoint(zmq_context):
+    """
+    Tests that the receiver correctly handles a request to a completely
+    unknown or non-existent endpoint.
+
+    :param zmq_context: The ZeroMQ context fixture.
+    :type zmq_context: zmq.Context
+    """
     receiver = MainReceiver(zmq_context)
     response = receiver.handle_message({
         "endpoint": "some_endpoint_that_definitely_does_not_exist",
@@ -67,6 +102,16 @@ def test_handle_unimplemented_endpoint(zmq_context):
 
 
 def test_handle_unimplemented_negotiation_endpoint(zmq_context):
+    """
+    Tests handling a request to an unknown sub-endpoint within a known
+    group
+    
+    The expected behavior is to return a specific "negotiate/error" response
+    with a descriptive error string.
+
+    :param zmq_context: The ZeroMQ context fixture.
+    :type zmq_context: zmq.Context
+    """
     receiver = MainReceiver(zmq_context)
     response = receiver.handle_message({
         "endpoint": "negotiate/but_some_subpath_that_definitely_does_not_exist",