From 69245cb5019b30ad6aeeb34186b8cc72b95cc5d3 Mon Sep 17 00:00:00 2001
From: NewSoupVi <57900059+NewSoupVi@users.noreply.github.com>
Date: Thu, 12 Sep 2024 15:12:14 +0200
Subject: [PATCH] Docstrings

---
 BaseClasses.py | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/BaseClasses.py b/BaseClasses.py
index 7eb40028cc..fce45500b8 100644
--- a/BaseClasses.py
+++ b/BaseClasses.py
@@ -1204,16 +1204,21 @@ class Location:
 
 
 class ItemClassification(IntFlag):
-    filler = 0b0000  # aka trash, as in filler items like ammo, currency etc,
-    progression = 0b0001  # Item that is logically relevant
-    # Protects this item from being placed on excluded or unreachable locations.
-    useful = 0b0010  # Item that is especially useful.
-    # Protects this item from being placed on excluded or unreachable locations.
-    # When combined with another flag like "progression", it means "an especially useful progression item".
-    trap = 0b0100  # detrimental item
-    skip_balancing = 0b1000  # should technically never occur on its own
-    # Item that is logically relevant, but progression balancing should not touch.
-    # Typically currency or other counted items.
+    filler = 0b0000
+    """ aka trash, as in filler items like ammo, currency etc """
+    progression = 0b0001
+    """ Item that is logically relevant.
+    Protects this item from being placed on excluded or unreachable locations. """
+    useful = 0b0010
+    """ Item that is especially useful.
+    Protects this item from being placed on excluded or unreachable locations.
+    When combined with another flag like "progression", it means "an especially useful progression item". """
+    trap = 0b0100
+    """ detrimental item """
+    skip_balancing = 0b1000
+    """ should technically never occur on its own
+    Item that is logically relevant, but progression balancing should not touch.
+    Typically currency or other counted items. """
     progression_skip_balancing = 0b1001  # only progression gets balanced
 
     def as_flag(self) -> int: