Document forge response classes (#1109)

Author: ItsDrike

docs/api/basic.rst

@@ -88,6 +88,32 @@ For Java Server (1.7+)
     :inherited-members:
     :exclude-members: build
 
+Forge Data
+**********
+
+Forge mod metadata is available on :attr:`status.forge_data <mcstatus.responses.JavaStatusResponse.forge_data>`.
+
+.. module:: mcstatus.forge_data
+    :no-index:
+
+.. autoclass:: mcstatus.forge_data.ForgeData()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build
+
+.. autoclass:: mcstatus.forge_data.ForgeDataChannel()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build, decode
+
+.. autoclass:: mcstatus.forge_data.ForgeDataMod()
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :exclude-members: build, decode
+
 
 For Java Server (1.4-1.6)
 *************************

mcstatus/forge_data.py

@@ -59,6 +59,8 @@ class RawForgeData(TypedDict, total=False):
 
 @dataclass(frozen=True)
 class ForgeDataChannel:
+    """A single Forge data channel."""
+
     name: str
     """Channel name and ID (for example ``fml:handshake``)."""
     version: str
@@ -98,8 +100,12 @@ def decode(cls, buffer: Connection, mod_id: str | None = None) -> Self:
 
 @dataclass(frozen=True)
 class ForgeDataMod:
+    """A single Forge mod."""
+
     name: str
+    """A mod name."""
     marker: str
+    """A mod marker. Usually a version."""
 
     @classmethod
     def build(cls, raw: RawForgeDataMod) -> Self:
@@ -193,12 +199,14 @@ def read_optimized_buffer(self) -> Connection:
 
 @dataclass(frozen=True)
 class ForgeData:
+    """Class for storing information about Forge mods."""
+
     fml_network_version: int
     """Forge Mod Loader network version."""
     channels: list[ForgeDataChannel]
     """List of channels, both for mods and non-mods."""
     mods: list[ForgeDataMod]
-    """List of mods"""
+    """List of mods."""
     truncated: bool
     """Is the mods list and or channel list incomplete?"""