Some extra docs and license info.

Author: EvieePy

twitchio/ext/commands/__init__.py

@@ -1,3 +1,27 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2017-2021 TwitchIO
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+"""
+
 from .bot import Bot
 from .core import *
 from .errors import *

twitchio/ext/commands/bot.py

@@ -284,6 +284,13 @@ def load_module(self, name: str):
         self._modules[name] = module
 
     def unload_module(self, name: str):
+        """Method which unloads a module and it's cogs.
+
+        Parameters
+        ----------
+        name: str
+            The name of the module to unload in dot.path format.
+        """
         if name not in self._modules:
             raise ValueError(f"Module <{name}> is not loaded")
 
@@ -308,6 +315,18 @@ def unload_module(self, name: str):
                 del sys.modules[m]
 
     def reload_module(self, name: str):
+        """Method which reloads a module and it's cogs.
+
+        Parameters
+        ----------
+        name: str
+            The name of the module to unload in dot.path format.
+
+
+        .. note::
+
+            This is roughly equivalent to `bot.unload_module(...)` then `bot.load_module(...)`.
+        """
         if name not in self._modules:
             raise ValueError(f"Module <{name}> is not loaded")
 
@@ -327,7 +346,19 @@ def reload_module(self, name: str):
             module.prepare(self)
             raise
 
-    def add_cog(self, cog):
+    def add_cog(self, cog: Cog):
+        """Method which adds a cog to the bot.
+
+        Parameters
+        ----------
+        cog: :class:`Cog`
+            The cog instance to add to the bot.
+
+
+        .. warning::
+
+            This must be an instance of :class:`Cog`.
+        """
         if not isinstance(cog, Cog):
             raise InvalidCog('Cogs must derive from "commands.Cog".')
 
@@ -338,6 +369,13 @@ def add_cog(self, cog):
         self._cogs[cog.name] = cog
 
     def remove_cog(self, cog_name: str):
+        """Method which removes a cog from the bot.
+
+        Parameters
+        ----------
+        cog_name: str
+            The name of the cog to remove.
+        """
         if cog_name not in self._cogs:
             raise InvalidCog(f"Cog '{cog_name}' not found")
 
@@ -397,10 +435,12 @@ async def global_after_invoke(self, ctx):
 
     @property
     def commands(self):
+        """The currently loaded commands."""
         return self._commands
 
     @property
     def cogs(self):
+        """The currently loaded cogs."""
         return self._cogs
 
     async def event_command_error(self, context, error):

twitchio/ext/commands/errors.py

@@ -24,6 +24,8 @@
 
 
 class TwitchCommandError(Exception):
+    """Base TwitchIO Command Error. All command errors derive from this error."""
+
     pass