aboutsummaryrefslogtreecommitdiff
path: root/tests/test_validations.py
diff options
context:
space:
mode:
authorCody Logan <cody@lokken.dev>2023-12-01 15:42:17 -0800
committerCody Logan <cody@lokken.dev>2023-12-01 15:42:17 -0800
commit514023f4c76cd140992a4ca6af769db0843ffce5 (patch)
treeb5b18931091547016dac252e267be0660619ec38 /tests/test_validations.py
parent318d9ad1a4679832b380c77ab1a0a86684f686f2 (diff)
downloadwikiget-docstrings.tar.gz
wikiget-docstrings.zip
Convert additional docstrings to Google-styledocstrings
Diffstat (limited to 'tests/test_validations.py')
-rw-r--r--tests/test_validations.py44
1 files changed, 26 insertions, 18 deletions
diff --git a/tests/test_validations.py b/tests/test_validations.py
index 780303a..b9d4fb9 100644
--- a/tests/test_validations.py
+++ b/tests/test_validations.py
@@ -44,10 +44,12 @@ class TestSiteInput:
def invalid_input(self, request: pytest.FixtureRequest) -> re.Match | None:
"""Return the results of checking various invalid site names.
- :param request: Pytest request object containing parameter values
- :type request: pytest.FixtureRequest
- :return: a Match object for the site or None if there was no match
- :rtype: re.Match
+ Args:
+ request (pytest.FixtureRequest): Pytest request object containing parameter
+ values
+
+ Returns:
+ re.Match: a Match object for the site or None if there was no match
"""
return valid_site(request.param)
@@ -62,10 +64,12 @@ class TestSiteInput:
def valid_input(self, request: pytest.FixtureRequest) -> re.Match | None:
"""Return the results of checking various valid site names.
- :param request: Pytest request object containing parameter values
- :type request: pytest.FixtureRequest
- :return: a Match object for the site or None if there was no match
- :rtype: re.Match
+ Args:
+ request (pytest.FixtureRequest): Pytest request object containing parameter
+ values
+
+ Returns:
+ re.Match: a Match object for the site or None if there was no match
"""
return valid_site(request.param)
@@ -88,8 +92,8 @@ class TestFileRegex:
The match object returned will have match groups corresponding to the file
prefix and name.
- :return: a Match object for the filename or None if there was no match
- :rtype: re.Match
+ Returns:
+ re.Match: a Match object for the filename or None if there was no match
"""
return valid_file("File:Example.jpg")
@@ -124,10 +128,12 @@ class TestFileInput:
def invalid_input(self, request: pytest.FixtureRequest) -> re.Match | None:
"""Return the results of checking various invalid filenames.
- :param request: Pytest request object containing parameter values
- :type request: pytest.FixtureRequest
- :return: a Match object for the filename or None if there was no match
- :rtype: re.Match
+ Args:
+ request (pytest.FixtureRequest): Pytest request object containing parameter
+ values
+
+ Returns:
+ re.Match: a Match object for the filename or None if there was no match
"""
return valid_file(request.param)
@@ -144,10 +150,12 @@ class TestFileInput:
def valid_input(self, request: pytest.FixtureRequest) -> re.Match | None:
"""Return the results of checking various valid filenames.
- :param request: Pytest request object containing parameter values
- :type request: pytest.FixtureRequest
- :return: a Match object for the filename or None if there was no match
- :rtype: re.Match
+ Args:
+ request (pytest.FixtureRequest): Pytest request object containing parameter
+ values
+
+ Returns:
+ re.Match: a Match object for the filename or None if there was no match
"""
return valid_file(request.param)