Update comments in mail validator tests
authorChristian Herdtweck <christian.herdtweck@intra2net.com>
Thu, 14 Nov 2019 10:49:39 +0000 (11:49 +0100)
committerPlamen Dimitrov <pdimitrov@pevogam.com>
Tue, 19 Nov 2019 09:03:59 +0000 (11:03 +0200)
test/test_mail_validator.py

index d5faba0..9405b74 100644 (file)
@@ -1,11 +1,6 @@
 #!/usr/bin/env python3
 
-""" Summary not created yet
-
-Details on what happens here should be specified here but please keep it brief!
-
-.. codeauthor:: Intra2net AG <info@intra2net.com>
-"""
+"""Unittests for class MailValidator."""
 
 import os
 import unittest
@@ -14,7 +9,12 @@ from src import mail_validator
 
 
 class MailUtilsValidatorTest(unittest.TestCase):
-    """Tests methods of :py:class:`mail_validator.MailValidator`."""
+    """
+    Tests methods of :py:class:`mail_validator.MailValidator`
+
+    Testing mail sending/"injecting" requires a mock smtp/imap server,
+    therefore not included yet.
+    ."""
 
     def setUp(self):
         os.mkdir("srcdir")