added proper docstrings for python scripts

.vscode/extensions.json

@@ -1,4 +1,5 @@
 // SPDX-License-Identifier: MIT
+
 {
  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

mcsrvstat/ext.py

@@ -18,26 +18,20 @@ class ServerPlatform(Enum):
 
 # Classes.
 class Icon:
- """
- Represents the icon of a server.
+ """Represents the icon of a server.
 
  Methods:
- `save()` - Saves the icon locally.
+ save(): Saves the icon locally.
  """
 
  def __init__(self, data: bytes):
  self.data = data
 
  def save(self, name: str = 'result') -> str:
- """
- Saves the icon on the local machine.
-
- Parameters:
- name (`str`): The name to use for the new file (doesn't change the format of the image).
- Defaults to `result`.
+ """Saves the icon locally.
 
- Returns:
- The full name (with extension) of the file.
+ Args:
+ name (str): The name to use for the image file. Defaults to "result".
  """
 
  im = Image.open(BytesIO(self.data))
@@ -50,12 +44,11 @@ def save(self, name: str = 'result') -> str:
 # Data classes.
 @dataclass(frozen=True)
 class Player:
- """
- Represents a player from the server.
+ """Represents a player from the server.
 
  Attributes:
- `name` - The friendly name of the player.\n
- `uuid` - The UUID of the player.
+ name (str): The friendly name of the player.
+ uuid (str): The UUID of the player.
  """
 
  name: str
@@ -64,13 +57,12 @@ class Player:
 
 @dataclass(frozen=True)
 class ServerMOTD:
- """
- Represents the 'Message of the Day' or 'MOTD' of the server.
+ """Represents the 'Message of the Day' or 'MOTD' of the server.
 
  Attributes:
- `raw` - No formatting, get the raw one.\n
- `clean` - Retrieve the MOTD in an already formatted way.\n
- `html` - Retrieve the MOTD in HTML.
+ raw (str): No formatting, get the raw one.
+ clean (str): Retrieve the MOTD in an already formatted way.
+ html (str): Retrieve the MOTD in HTML.
  """
 
  raw: str
@@ -80,13 +72,12 @@ class ServerMOTD:
 
 @dataclass(frozen=True)
 class ServerInfo:
- """
- The default class for accessing base server information in different formats.
+ """The default class for accessing base server information in different formats.
 
  Attributes:
- `raw` - No formatting, get the raw one.\n
- `clean` - Retrieve the info in an already formatted way.\n
- `html` - Retrieve the info in HTML.
+ raw (list): No formatting, get the raw one.
+ cleaw (list): Retrieve the info in an already formatted way.
+ htmw (list): Retrieve the info in HTML.
  """
 
  raw: list
@@ -96,12 +87,11 @@ class ServerInfo:
 
 @dataclass(frozen=True)
 class ServerPlugin:
- """
- Represents a server plugin.
+ """Represents a server plugin.
 
  Attributes:
- `name` - The name of the plugin.\n
- `version` - The version of the plugin.
+ name (str): The name of the plugin.
+ version (str): The version of the plugin.
  """
 
  name: str
@@ -110,12 +100,11 @@ class ServerPlugin:
 
 @dataclass(frozen=True)
 class ServerMod:
- """
- Represents a server mod.
+ """Represents a mod installed on the server.
 
  Attributes:
- `name` - The name of the mod.\n
- `version` - The version of the mod.
+ name (str): The name of the mod.
+ version (str): The version of the mod.
  """
 
  name: str
@@ -124,13 +113,14 @@ class ServerMod:
 
 @dataclass(frozen=True)
 class ServerDebugInfo:
- """
- The default class for accessing server debug values.
+ """The default class for accessing server debug values.
 
  Attributes:
  Get information on different debug values from the official [documentation](https://api.mcsrvstat.us).
  """
 
+ # TODO: Add detailed explanation on the debug values instead of refering to external links
+
  ping: bool
  query: bool
  srv: bool
@@ -150,8 +140,8 @@ class PlayerCount:
  Represents the current player count of the server.
 
  Attributes:
- `online` - The amount of players currently online.\n
- `max` - The maximum amount of players the server can hold at a time.
+ online (int): The amount of players currently online.\n
+ max (int): The maximum amount of players the server can hold at a time.
  """
 
  online: int