Fixed comment format (now renders properly)

test.py

@@ -1,13 +1,14 @@
 #!/usr/bin/env python
 
+"""
+Unit tests for the producer module.
+"""
+
 import re
 import consumerlocator
 import communicator
 import messagesender
 
-"""
-Unit tests for producer module.
-"""
 
 __author__ = "@tormakris"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
@@ -19,8 +20,9 @@ generateduuid = 'c959ad81-58f9-4445-aab4-8f3d68aee1ad'
 
 def test_generate_string(mocker):
     """
-    Tests :func:'~messagesender.MessageSender.randomstring'.
-    :param: mocker:
+    Tests :func:`messagesender.MessageSender.randomstring`.
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     """
     mocker.patch('communicator.Communicator')
     comm = communicator.Communicator(
@@ -34,7 +36,8 @@ def test_generate_string(mocker):
 
 def test_sendmessage(httpserver):
     """
-    Tests :func:'~communicator.Communicator.sendmessage'.
+    Tests :func:`communicator.Communicator.sendmessage`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -56,8 +59,9 @@ def test_sendmessage(httpserver):
 
 def test_send_message(mocker):
     """
-    Tests :func:'~messagesender.MessageSender.sendmessage'.
-    :param mocker:
+    Tests :func:`messagesender.MessageSender.sendmessage`.
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     :return: None
     """
     mocker.patch('communicator.Communicator')
@@ -72,7 +76,8 @@ def test_send_message(mocker):
 
 def test_discoveravailableconsumers(httpserver):
     """
-    Tests :func:'~communicator.Communicator.discoveravailableconsumers'
+    Tests :func:`communicator.Communicator.discoveravailableconsumers`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -93,7 +98,8 @@ def test_discoveravailableconsumers(httpserver):
 
 def test_isconsumeravailable(httpserver):
     """
-    Tests :func:'~communicator.Communicator.isconsumeravailable'
+    Tests :func:`communicator.Communicator.isconsumeravailable`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -126,7 +132,8 @@ def test_isconsumeravailable(httpserver):
 
 def test_checkconsumer(httpserver):
     """
-    Tests :func:'~communicator.Communicator.checkconsumer'
+    Tests :func:`communicator.Communicator.checkconsumer`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -159,7 +166,8 @@ def test_checkconsumer(httpserver):
 
 def test_setcurrentconsumer():
     """
-    Tests :func:'~communicator.Communicator.set_currentconsumer'
+    Tests :func:`communicator.Communicator.set_currentconsumer`
+
     :return: None
     """
     comm = communicator.Communicator(
@@ -171,7 +179,8 @@ def test_setcurrentconsumer():
 
 def test_learnconsumerlist(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.learnconsumerlist'
+    Tests :func:`consumerlocator.ConsumerLocator.learnconsumerlist`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -194,8 +203,9 @@ def test_learnconsumerlist(httpserver):
 
 def test_getcurrentconsumer(mocker):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.getcurrentconsumer'
-    :param mocker:
+    Tests :func:`consumerlocator.ConsumerLocator.getcurrentconsumer`
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     :return: None
     """
     mocker.patch('communicator.Communicator')
@@ -209,7 +219,8 @@ def test_getcurrentconsumer(mocker):
 
 def test_checkcurrentconsumer(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.checkcurrentconsumer'
+    Tests :func:`consumerlocator.ConsumerLocator.checkcurrentconsumer`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -232,7 +243,8 @@ def test_checkcurrentconsumer(httpserver):
 
 def test_updateconsumer(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.updateconsumer'
+    Tests :func:`consumerlocator.ConsumerLocator.updateconsumer`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -256,7 +268,8 @@ def test_updateconsumer(httpserver):
 
 def test_updateconsumerlist(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.updateconsumerlist'
+    Tests :func:`consumerlocator.ConsumerLocator.updateconsumerlist`
+
     :param httpserver: simple HTTP server
     :return: None
     """