From b6e77f58025576020229b3355238fcb7f66a8032 Mon Sep 17 00:00:00 2001
From: Christian Helle <christian.helle@outlook.com>
Date: Sat, 19 Oct 2024 17:30:51 +0200
Subject: [PATCH] Re-format @autodata and @fakedata comments

---
 src/autofaker/decorators.py | 51 +++++++++++++++++++++++++++----------
 1 file changed, 38 insertions(+), 13 deletions(-)

diff --git a/src/autofaker/decorators.py b/src/autofaker/decorators.py
index 5668886..f6bd6a5 100644
--- a/src/autofaker/decorators.py
+++ b/src/autofaker/decorators.py
@@ -1,5 +1,6 @@
 """
-Provides anonymous object creation functions to help minimize the setup/arrange phase when writing unit tests
+Provides anonymous object creation functions to help minimize
+the setup/arrange phase when writing unit tests
 """
 
 import inspect
@@ -11,7 +12,8 @@
 
 def autodata(*types: object, use_fake_data: bool = False):
     """
-    Creates anonymous variable of the requested types and pass them as arguments to a unit test function
+    Creates anonymous variable of the requested types
+    and pass them as arguments to a unit test function
 
     Example:
 
@@ -26,8 +28,14 @@ def test_create_str_argument_using_decorator(self, text, number, decimal, boolea
             self.assertIsNotNone(text)
 
 
-    :param use_fake_data: bool - Set this to True to use Faker to generate data, otherwise False to generate anonymous data
-    :param type types: tuple - The types to generate data. This is optional and will use the arguments from the function being decorated if not specified
+    :param use_fake_data: bool
+        Set this to True to use Faker to generate data,
+        otherwise False to generate anonymous data
+
+    :param type types: tuple
+        The types to generate data.
+        This is optional and will use the arguments
+        from the function being decorated if not specified
     """
 
     def decorator(function):
@@ -56,7 +64,8 @@ def wrapper(*args):
 
 def fakedata(*types: object):
     """
-    Creates fake values for the variables of the requested types and pass them as arguments to a unit test function
+    Creates fake values for the variables of the requested types
+    and pass them as arguments to a unit test function
 
     Example:
 
@@ -71,7 +80,10 @@ def test_create_fake_arguments(self, text: str, number: int, decimal: float, boo
             self.assertIsNotNone(text)
 
 
-    :param types: object - The types to generate data. This is optional and will use the arguments from the function being decorated if not specified
+    :param types: object
+        The types to generate data.
+        This is optional and will use the arguments from the function
+        being decorated if not specified
     """
 
     def decorator(function):
@@ -98,11 +110,19 @@ def wrapper(*args):
 
 def autopandas(t: object, rows: int = 3, use_fake_data: bool = False):
     """
-    Create a Pandas DataFrame containing anonymous data with the specified number of rows (default 3)
+    Create a Pandas DataFrame containing anonymous data
+    with the specified number of rows (default 3)
+
+    :param type t: object
+        The class that represents the DataFrame.
+        This can be a plain old class or a @dataclass
 
-    :param type t: object - The class that represents the DataFrame. This can be a plain old class or a @dataclass
-    :param type rows: int - The number of rows to generate for the DataFrame (default 3)
-    :param use_fake_data: bool - Set this to True to use Faker to generate data, otherwise False to generate anonymous data
+    :param type rows: int
+        The number of rows to generate for the DataFrame (default 3)
+
+    :param use_fake_data: bool
+        Set this to True to use Faker to generate data,
+        otherwise False to generate anonymous data
     """
 
     def decorator(function):
@@ -121,10 +141,15 @@ def wrapper(*args):
 
 def fakepandas(t, rows: int = 3):
     """
-    Create a Pandas DataFrame containing fake data with the specified number of rows (default 3)
+    Create a Pandas DataFrame containing fake data with
+    the specified number of rows (default 3)
+
+    :param type t: object
+        The class that represents the DataFrame.
+        This can be a plain old class or a @dataclass
 
-    :param type t: object - The class that represents the DataFrame. This can be a plain old class or a @dataclass
-    :param type rows: int - The number of rows to generate for the DataFrame (default 3)
+    :param type rows: int
+        The number of rows to generate for the DataFrame (default 3)
     """
     return autopandas(t, rows, use_fake_data=True)