add extract-emoji's docstring

livingbio · Jun 14, 2024 · e6869f9 · e6869f9
1 parent bce3801
commit e6869f9
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/pr_lint/main.py b/src/pr_lint/main.py
@@ -19,6 +19,15 @@
 
 
 def extract_emoji(string: str) -> set[str]:
+    """
+    Extracts emojis from a string
+
+    Args:
+        string: The string to extract emojis from
+
+    Returns:
+        A set of emojis
+    """
     return set(emoji_pattern.findall(string))