From e5141c186d3dfad983eac9c3fb6ea420a0507f4e Mon Sep 17 00:00:00 2001
From: Bastian Schroll <bastian@schroll-software.de>
Date: Tue, 14 Apr 2020 18:47:12 +0200
Subject: [PATCH] add comments

---
 test/module/test_descriptor.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/test/module/test_descriptor.py b/test/module/test_descriptor.py
index c064170..6309e79 100644
--- a/test/module/test_descriptor.py
+++ b/test/module/test_descriptor.py
@@ -31,6 +31,7 @@ def setup_method(method):
 
 @pytest.fixture
 def makeDescriptor():
+    """!Build a descriptor object with loaded configuration"""
     config = ConfigYAML()
     assert config.loadConfigFile(paths.TEST_PATH + "test_config.yaml") is True
     descriptor = Descriptor(config.get("descriptor_test"))
@@ -39,23 +40,27 @@ def makeDescriptor():
 
 @pytest.fixture
 def makePacket():
+    """!Build a BW Packet object"""
     packet = Packet()
     return packet
 
 
 def test_descriptorFoundFirst(makeDescriptor, makePacket):
+    """!Run descriptor on the first entry in list"""
     makePacket.set("tone", "12345")
     makePacket = makeDescriptor.doWork(makePacket)
     assert makePacket.get("description") == "Test 12345"
 
 
 def test_descriptorFoundSecond(makeDescriptor, makePacket):
+    """!Run descriptor on the second entry in list"""
     makePacket.set("tone", "23456")
     makePacket = makeDescriptor.doWork(makePacket)
     assert makePacket.get("description") == "Test 23456"
 
 
 def test_descriptorNotFound(makeDescriptor, makePacket):
+    """!Run descriptor on a non existent field"""
     makePacket.set("tone", "99999")
     makePacket = makeDescriptor.doWork(makePacket)
     assert makePacket.get("description") == "99999"