From b134a2081375f26e1ab812b9680475b96e445d0d Mon Sep 17 00:00:00 2001
From: C4 Patino <c4patino@gmail.com>
Date: Mon, 5 Sep 2022 15:43:46 -0500
Subject: [PATCH] Changed documentation to reStructuredText strings

---
 CollegiateHouseWars/settings/test.py |  4 ++++
 housewars/utils/get_random_string.py | 13 +++----------
 housewars/utils/unpack_values.py     | 17 +++++++----------
 3 files changed, 14 insertions(+), 20 deletions(-)

diff --git a/CollegiateHouseWars/settings/test.py b/CollegiateHouseWars/settings/test.py
index 07c9e59..71f14df 100644
--- a/CollegiateHouseWars/settings/test.py
+++ b/CollegiateHouseWars/settings/test.py
@@ -42,6 +42,10 @@ INSTALLED_APPS = [
     'housewars.apps.HousewarsConfig'
 ]
 
+PASSWORD_HASHERS = [
+    'django.contrib.auth.hashers.MD5PasswordHasher'
+]
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
diff --git a/housewars/utils/get_random_string.py b/housewars/utils/get_random_string.py
index 62a456e..4919293 100644
--- a/housewars/utils/get_random_string.py
+++ b/housewars/utils/get_random_string.py
@@ -2,18 +2,11 @@ import random
 import string
 
 
-def get_random_string(length):
+def get_random_string(length: int) -> str:
     """Generates a random string of length n
 
-    Parameters
-    ----------
-    length : int
-        The desired length of the returned string
-
-    Returns
-    -------
-    str
-        A random string of length n
+    :param length int: The desired length of the returned string
+    :return: A random string of length n
     """
 
     letters = string.ascii_lowercase
diff --git a/housewars/utils/unpack_values.py b/housewars/utils/unpack_values.py
index 2d2cd9e..1c1f46d 100644
--- a/housewars/utils/unpack_values.py
+++ b/housewars/utils/unpack_values.py
@@ -1,15 +1,12 @@
-def unpack_values(queryset):
+from django.db.models import QuerySet
+from typing import List
+
+
+def unpack_values(queryset: QuerySet) -> List[List]:
     """Unpacks a queryset into a 2D array
 
-    Parameters
-    ----------
-    queryset : int
-        The queryset that will be unpacked
-
-    Returns
-    -------
-    data : [list]
-        A random string of length n
+    :param queryset: The queryset that will be unpacked
+    :returns A table headers, then rows
     """
 
     field_names = [field.name for field in queryset.model._meta.fields]