Clarification Changes

app/api/admin_sales/events.py

@@ -12,7 +12,8 @@
 
 class AdminSalesByEventsSchema(Schema):
     """
-    Sales summarized by event
+    Sales summarized by event. Mainly includes information on the event
+    itself, but also includes some info on the sales and tickets of the event.
 
     Provides
         event(name),

app/models/helpers/versioning.py

@@ -3,15 +3,21 @@
 import bleach
 from bleach.callbacks import nofollow, target_blank
 
+"""
+Class to modify strings
+"""
 
+# Removes \r
 def remove_line_breaks(target_string: str) -> str:
     return target_string.replace('\r', '')
 
 
+# Removes \n
 def strip_line_breaks(target_string: str) -> str:
     return target_string.replace('\n', '').replace('\r', '')
 
 
+# Removes whitespace and \r, then removes \n if it contains a-z or A-Z
 def clean_up_string(target_string):
     if target_string:
         if not re.search('[a-zA-Z]', target_string):
@@ -20,6 +26,7 @@ def clean_up_string(target_string):
     return target_string
 
 
+# Makes html safe
 def clean_html(html, allow_link=False):
     if html is None:
         return None
@@ -53,6 +60,7 @@ def clean_html(html, allow_link=False):
     )
 
 
+# Removes html from text
 def strip_tags(html):
     if html is None:
         return None

app/models/utils.py

@@ -37,24 +37,31 @@ def checkout(dbapi_connection, connection_record, connection_proxy):
                 "attempting to check out in pid %s" % (connection_record.info['pid'], pid)
             )
 
-
+# Adjusts the DateTime handling for SQLite databases in SQLAlchemy by converting DateTime fields into an integer format that stores timestamps as seconds.
 def sqlite_datetime_fix():
+
+    # Converts DateTime objects to Unix timestamps before storage and converts them back to DateTime when retrieved. 
     class SQLiteDateTimeType(types.TypeDecorator):
         impl = types.Integer
         epoch = datetime(1970, 1, 1, 0, 0, 0)
 
+        # Converts a DateTime object to Unix timestamp when storing the value in the SQLite database.
         def process_bind_param(self, value, dialect):
             return (value / 1000 - self.epoch).total_seconds()
 
+        # Converts a Unix timestamp back to a DateTime object when retrieving the value from the SQLite database. 
         def process_result_value(self, value, dialect):
             return self.epoch + timedelta(seconds=value / 1000)
 
+    # Checks if the current database engine is SQLite.
     def is_sqlite(inspector):
         return inspector.engine.dialect.name == "sqlite"
 
+    # Checks if a given column is a DateTime.
     def is_datetime(column_info):
         return isinstance(column_info['type'], types.DateTime)
 
+    # Adjusts DateTime columns when reflecting tables in SQLite.
     @event.listens_for(Table, "column_reflect")
     def setup_epoch(inspector, table, column_info):
         if is_sqlite(inspector) and is_datetime(column_info):

docs/installation/basic.md

@@ -7,6 +7,9 @@
 * Postgres
 * OpenSSL
 
+### A quick note for Windows users
+Some files within the migrations/versions directory contain illegal file names for a Windows system. The Open Event Server is not optimized for running locally on a Windows machine. Therefore, it is suggested that you use Windows Subsystem for Linux (WSL) or a virtual machine to run the project locally. The setup steps for WSL can be found here: https://learn.microsoft.com/en-us/windows/wsl/install. Once using one of these options, you should be able to complete the following linux setup steps within WSL.
+
 ### For mac users
 ```sh
 brew install postgresql