add docstrings to dataclasses

dnd_character/classes.py

@@ -6,6 +6,12 @@
 
 @dataclass(kw_only=True, frozen=True, slots=True)
 class _CLASS:
+    """
+    Dataclass for (D&D 5e) classes. Classes are suggested to be constants. (Immutable.)
+    So deserialization shouldn't be necessary, but is possible with _CLASS(**dict).
+    Or get the constant version from `dnd_character.classes.CLASSES[class_name]`
+    """
+
     index: str
     name: str
     url: str

dnd_character/equipment.py

@@ -12,6 +12,8 @@
 
 @dataclass(kw_only=True)
 class _Item:
+    """Dataclass for items. Deserialize item with `_Item(**dict)` or Item() function"""
+
     uid: str = uuid4().hex
     contents: list[dict[str, Union[int, dict[str, str]]]]
     cost: dict[str, Union[str, int]]

dnd_character/monsters.py

@@ -12,6 +12,8 @@
 
 @dataclass(kw_only=True)
 class _Monster:
+    """Dataclass for items. Deserialize item with `_Monster(**dict)` or Monster() function"""
+
     index: str
     uid: str = uuid4().hex
     type: str

dnd_character/spellcasting.py

@@ -11,6 +11,12 @@
 
 @dataclass(kw_only=True, frozen=True, slots=True)
 class _SPELL:
+    """
+    Dataclass for spells. Spells are suggested to be constants. (Immutable.)
+    So deserialization shouldn't be necessary, but is possible with _SPELL(**dict).
+    Or get the constant version from `dnd_character.spellcasting.SPELLS[spell_name]`
+    """
+
     area_of_effect: Optional[dict[str, Union[str, int]]] = None
     attack_type: Optional[str] = None
     casting_time: str