Add missing shard error documentation (#2100)

Signed-off-by: Blaze <[email protected]> Co-authored-by: davfsa <[email protected]>
hikari-py · Nov 12, 2024 · cca2c51 · cca2c51
1 parent 4c25d98
commit cca2c51
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/changes/2100.documentation.md b/changes/2100.documentation.md
@@ -0,0 +1 @@
+Added missing documentation for `GatewayShard` and for trait `ShardAware`, adding missing errors which can be thrown.
diff --git a/hikari/api/shard.py b/hikari/api/shard.py
@@ -112,6 +112,11 @@ def get_user_id(self) -> snowflakes.Snowflake:
         -------
         hikari.snowflakes.Snowflake
             The user ID for the application user.
+
+        Raises
+        ------
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
 
     @abc.abstractmethod
@@ -158,6 +163,11 @@ async def update_presence(
             changed.
         status
             The web status to show. If undefined, this will not be changed.
+
+        Raises
+        ------
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
 
     @abc.abstractmethod
@@ -185,6 +195,11 @@ async def update_voice_state(
         self_deaf
             If specified and [`True`][], the bot will deafen itself in that
             voice channel. If [`False`][], then it will undeafen itself.
+
+        Raises
+        ------
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
 
     @abc.abstractmethod
@@ -227,4 +242,6 @@ async def request_guild_members(
         hikari.errors.MissingIntentError
             When trying to request presences without the [`hikari.intents.Intents.GUILD_MEMBERS`][] or when trying to
             request the full list of members without [`hikari.intents.Intents.GUILD_PRESENCES`][].
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
diff --git a/hikari/traits.py b/hikari/traits.py
@@ -315,6 +315,11 @@ async def update_presence(
             changed.
         status
             The web status to show. If undefined, this will not be changed.
+
+        Raises
+        ------
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
         raise NotImplementedError
 
@@ -349,6 +354,8 @@ async def update_voice_state(
         RuntimeError
             If the guild passed isn't covered by any of the shards in this sharded
             client.
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
 
     @abc.abstractmethod
@@ -394,6 +401,8 @@ async def request_guild_members(
         RuntimeError
             If the guild passed isn't covered by any of the shards in this sharded
             client.
+        hikari.errors.ComponentStateConflictError
+            When the shard is not connected so it cannot be interacted with.
         """
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Added missing documentation for `GatewayShard` and for trait `ShardAware`, adding missing errors which can be thrown.