document the instance attributes of BotBase

Author: shtlrs

docs/changelog.rst

@@ -4,6 +4,9 @@
 Changelog
 =========
 
+- :release:`10.8.0 <18th February 2024>`
+- :support:`204` Document the instance attributes of :obj:`pydis_core.BotBase`.
+
 - :release:`10.7.0 <30th January 2024>`
 - :feature:`158` Add locking utilities for controlling concurrency logic
 - :support:`202` Bump various development dependencies and CI workflow action versions

pydis_core/_bot.py

@@ -33,7 +33,20 @@ def __init__(self, base: Exception):
 
 
 class BotBase(commands.Bot):
-    """A sub-class that implements many common features that Python Discord bots use."""
+    """
+    A sub-class that implements many common features that Python Discord bots use.
+
+    Attributes:
+        guild_id (int): ID of the guild that the bot belongs to.
+        http_session (aiohttp.ClientSession): The http session used for sending out HTTP requests.
+        api_client (pydis_core.site_api.APIClient): The API client used for communications with the site service.
+        statsd_url (str): The url that statsd sends metrics to.
+        redis_session (async_rediscache.RedisSession): The redis session used to communicate with the Redis instance.
+        stats (pydis_core.async_stats.AsyncStatsClient): The statsd client that sends metrics.
+        all_extensions (frozenset[str]): All extensions that were found within the ``module`` passed to
+            ``self.load_extensions``. Use ``self.extensions`` to get the loaded extensions.
+
+    """
 
     def __init__(
         self,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydis_core"
-version = "10.7.0"
+version = "10.8.0"
 description = "PyDis core provides core functionality and utility to the bots of the Python Discord community."
 authors = ["Python Discord <info@pythondiscord.com>"]
 license = "MIT"