added docstrings on 5 tests

Author: ericksc

tests/test_email_control_character.py

@@ -1,9 +1,18 @@
 """HU-02: reject SOH in an address intended for SMTP (RFC 5321)."""
+
+# external
+import pytest
+
 import validators
 
 
-def test_email_rejects_soh_control_character():
-    # The Python escape introduces the actual ASCII SOH character.
-    email = '"user\x01name"@example.com'
+@pytest.mark.parametrize(
+    ("email",),
+    [
+        ('"user\x01name"@example.com', ),
+    ],
+)
+def test_email_rejects_soh_control_character(email: str):
+    """The Python escape introduces the actual ASCII SOH character."""
     result = validators.email(email)
     assert isinstance(result, validators.ValidationError), repr(result)

tests/test_email_ipv6_literal.py

@@ -1,9 +1,20 @@
 """HU-02: accept the IPv6: prefix in an SMTP address literal."""
+
+# external
+import pytest
+
 import validators
 
 
-def test_email_accepts_ipv6_literal_with_prefix():
+@pytest.mark.parametrize(
+    ("email",),
+    [
+        ("usuario@[IPv6:2001:db8::1]", ),
+    ],
+)
+def test_email_accepts_ipv6_literal_with_prefix(email: str):
+    """Email accepts ipv6 literal with prefix."""
     result = validators.email(
-        "usuario@[IPv6:2001:db8::1]", ipv6_address=True
+        email, ipv6_address=True
     )
     assert result is True, repr(result)

tests/test_email_quoted_at_sign.py

@@ -1,7 +1,18 @@
 """HU-02: accept @ inside a quoted local part."""
+
+# external
+import pytest
+
 import validators
 
 
-def test_email_accepts_at_sign_inside_quoted_local_part():
-    result = validators.email('"user@name"@example.com')
+@pytest.mark.parametrize(
+    ("email",),
+    [
+        ('"user@name"@example.com', ),
+    ],
+)
+def test_email_accepts_at_sign_inside_quoted_local_part(email: str):
+    """The email accepts at sign inside quoted local part character."""
+    result = validators.email(email)
     assert result is True, repr(result)

tests/test_ipv4_strict_cidr.py

@@ -1,8 +1,18 @@
 """HU-04: require a prefix length in the documented strict CIDR mode."""
+
+# external
+import pytest
+
 import validators
 
 
-def test_ipv4_strict_cidr_rejects_dotted_netmask():
-    # The network is valid, but its representation is not CIDR prefix notation.
-    result = validators.ipv4("192.168.1.0/255.255.255.0", strict=True)
+@pytest.mark.parametrize(
+    ("ip",),
+    [
+        ("192.168.1.0/255.255.255.0", ),
+    ],
+)
+def test_ipv4_strict_cidr_rejects_dotted_netmask(ip: str):
+    """The network is valid, but its representation is not CIDR prefix notation."""
+    result = validators.ipv4(ip, strict=True)
     assert isinstance(result, validators.ValidationError), repr(result)

tests/test_ipv6_brackets.py

@@ -2,9 +2,20 @@
 
 This test expresses a new requirement, not a defect in the current contract.
 """
+
+# external
+import pytest
+
 import validators
 
 
-def test_ipv6_accepts_address_in_brackets():
-    result = validators.ipv6("[2001:db8::1]")
+@pytest.mark.parametrize(
+    ("ip",),
+    [
+        ("[2001:db8::1]", ),
+    ],
+)
+def test_ipv6_accepts_address_in_brackets(ip: str):
+    """Accept iv6 address in brackets."""
+    result = validators.ipv6(ip)
     assert result is True, repr(result)