Add new alias and docs

Plurk-Project · Oct 24, 2020 · 999eb0b · 999eb0b
1 parent 87ebfa3
commit 999eb0b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/plurk_dice/dice.py b/plurk_dice/dice.py
@@ -18,6 +18,7 @@
     "dice20": 20,
     "draw": "lots",
     "lot": "lots",
+    "bz": "bzz",
     "bzzz": "bzz",
 }
 DICE = {
@@ -141,6 +142,15 @@ def roll(self, base64=False) -> Dict[str, Union[str, int]]:
 
     @classmethod
     def parse(cls, text: str, **kwargs) -> List[Dict[str, Union[str, int]]]:
+        """Parse text like usage in Plurk.
+
+        Args:
+            text (str): Text input
+            kwargs: passed into `cls.roll()`
+
+        Returns:
+            List[Dict[str, Union[str, int]]]: All results from parsed dices.
+        """
         results = re.findall(r"\((.*?)\)", text)
         return [cls(DICE_ALIAS.get(r, r)).roll(**kwargs) for r in results]