Documentation additions and fixes (#804)

* Documentation additions and fixes

Clarify nox and towncrier reqs for contributors

* Add changelog fragment

* Update changelog fragments and CONTRIBUTING.md

CONTRIBUTING.md

@@ -28,6 +28,12 @@ match that of the versioning scheme. There are utilities under `hikari.internal.
 
 To aid with the generation of `CHANGELOG.md` as well as the releases changelog we use `towncrier`.
 
+You will need to install `towncrier` and `hikari` from source before making changelog additions.
+```bash
+pip install towncrier
+pip install -e .
+```
+
 For every pull request made to this project, there should be a short explanation of the change under `changes/`
 with the following format: `{pull_request_number}.{type}.md`,
 
@@ -44,7 +50,7 @@ description so that a maintainer can skip the job that checks for newly added fr
 Best way to create the fragments is to run `towncrier create {pull_request_number}.{type}.md` after creating the
 pull request, edit the created file and committing the changes.
 
-Multiple fragments types can be created per pull request if it covers multiple areas.
+Multiple fragment types can be created per pull request if it covers multiple areas.
 
 # Branches
 
@@ -65,6 +71,11 @@ with a small description of the branch.
 
 We have nox to help out with running pipelines locally and provides some helpful functionality.
 
+You will need to install `nox` locally before running any pipelines.
+```bash
+pip install nox
+```
+
 Nox is similar to tox, but uses a pure Python configuration instead of an INI based configuration. Nox and tox are
 both tools for generating virtual environments and running commands in those environments. Examples of usage include
 installing, configuring, and running flake8, running pytest, etc.

changes/804.doc.md

@@ -0,0 +1 @@
+Add docstrings to the remaining undocumented `GatewayBot` methods

changes/804.feature.md

@@ -0,0 +1 @@
+Add the `add_component` method to `hikari.api.special_endpoints.ActionRowBuilder`

hikari/api/event_manager.py

@@ -231,9 +231,11 @@ async def on_everyone_mentioned(event):
 
         See Also
         --------
-        Subscribe: `hikari.api.event_manager.EventManager.subscribe`
+        Listen: `hikari.api.event_manager.EventManager.listen`
         Stream: `hikari.api.event_manager.EventManager.stream`
-        Wait for: `hikari.api.event_manager.EventManager.wait_for`
+        Subscribe: `hikari.api.event_manager.EventManager.subscribe`
+        Unsubscribe: `hikari.api.event_manager.EventManager.unsubscribe`
+        Wait_for: `hikari.api.event_manager.EventManager.wait_for`
         """
 
     # Yes, this is not generic. The reason for this is MyPy complains about
@@ -271,9 +273,11 @@ async def on_message(event):
 
         See Also
         --------
+        Dispatch: `hikari.api.event_manager.EventManager.dispatch`
         Listen: `hikari.api.event_manager.EventManager.listen`
         Stream: `hikari.api.event_manager.EventManager.stream`
-        Wait for: `hikari.api.event_manager.EventManager.wait_for`
+        Unsubscribe: `hikari.api.event_manager.EventManager.unsubscribe`
+        Wait_for: `hikari.api.event_manager.EventManager.wait_for`
         """
 
     # Yes, this is not generic. The reason for this is MyPy complains about
@@ -306,6 +310,14 @@ async def on_message(event):
 
         bot.unsubscribe(MessageCreateEvent, on_message)
         ```
+
+        See Also
+        --------
+        Dispatch: `hikari.api.event_manager.EventManager.dispatch`
+        Listen: `hikari.api.event_manager.EventManager.listen`
+        Stream: `hikari.api.event_manager.EventManager.stream`
+        Subscribe: `hikari.api.event_manager.EventManager.subscribe`
+        Wait_for: `hikari.api.event_manager.EventManager.wait_for`
         """
 
     @abc.abstractmethod
@@ -373,7 +385,7 @@ def listen(
         Stream: `hikari.api.event_manager.EventManager.stream`
         Subscribe: `hikari.api.event_manager.EventManager.subscribe`
         Unsubscribe: `hikari.api.event_manager.EventManager.unsubscribe`
-        Wait for: `hikari.api.event_manager.EventManager.wait_for`
+        Wait_for: `hikari.api.event_manager.EventManager.wait_for`
         """
 
     @abc.abstractmethod
@@ -439,7 +451,7 @@ def stream(
         Listen: `hikari.api.event_manager.EventManager.listen`
         Subscribe: `hikari.api.event_manager.EventManager.subscribe`
         Unsubscribe: `hikari.api.event_manager.EventManager.unsubscribe`
-        Wait for: `hikari.api.event_manager.EventManager.wait_for`
+        Wait_for: `hikari.api.event_manager.EventManager.wait_for`
         """
 
     @abc.abstractmethod
@@ -486,8 +498,9 @@ async def wait_for(
 
         See Also
         --------
+        Dispatch: `hikari.api.event_manager.EventManager.dispatch`
         Listen: `hikari.api.event_manager.EventManager.listen`
         Stream: `hikari.api.event_manager.EventManager.stream`
         Subscribe: `hikari.api.event_manager.EventManager.subscribe`
-        Dispatch: `hikari.api.event_manager.EventManager.dispatch`
+        Unsubscribe: `hikari.api.event_manager.EventManager.unsubscribe`
         """

hikari/api/special_endpoints.py

@@ -1491,6 +1491,30 @@ def components(self) -> typing.Sequence[ComponentBuilder]:
             Sequence of the component builders registered within this action row.
         """
 
+    @abc.abstractmethod
+    def add_component(
+        self: _T,
+        component: ComponentBuilder,
+        /,
+    ) -> _T:
+        """Add a component to this action row builder.
+
+        !!! warning
+            It is generally better to use `ActionRowBuilder.add_button`
+            and `ActionRowBuilder.add_select_menu` to add your
+            component to the builder. Those methods utilize this one.
+
+        Parameters
+        ----------
+        component : ComponentBuilder
+            The component builder to add to the action row.
+
+        Returns
+        -------
+        ActionRowBuilder
+            The builder object to enable chained calls.
+        """
+
     @typing.overload
     @abc.abstractmethod
     def add_button(

hikari/guilds.py

@@ -2931,7 +2931,7 @@ def get_voice_state(
     def get_emoji(
         self, emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji]
     ) -> typing.Optional[emojis_.KnownCustomEmoji]:
-        """Get a cached role that belongs to the guild by it's ID or object.
+        """Get a cached emoji that belongs to the guild by it's ID or object.
 
         Parameters
         ----------