Improve Emoji.parse typing (#1870)

hikari-py · Apr 7, 2024 · af31e9b · af31e9b
1 parent 3e05187
commit af31e9b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/changes/1870.feature.md b/changes/1870.feature.md
@@ -0,0 +1 @@
+Improve `Emoji.parse` typing to make it more explicit
diff --git a/hikari/emojis.py b/hikari/emojis.py
@@ -81,7 +81,7 @@ def mention(self) -> str:
         """Mention string to use to mention the emoji with."""
 
     @classmethod
-    def parse(cls, string: str, /) -> Emoji:
+    def parse(cls, string: str, /) -> typing.Union[UnicodeEmoji, CustomEmoji]:
         """Parse a given string into an emoji object.
 
         Parameters
@@ -91,7 +91,7 @@ def parse(cls, string: str, /) -> Emoji:
 
         Returns
         -------
-        Emoji
+        typing.Union[UnicodeEmoji, CustomEmoji]
             The parsed emoji object. This will be a [`hikari.emojis.CustomEmoji`][] if a custom
             emoji mention, or a [`hikari.emojis.UnicodeEmoji`][] otherwise.