From 47f491039c73c75af24fd17b400ad14ad4075528 Mon Sep 17 00:00:00 2001
From: Ju4tCode <42488585+yanyongyu@users.noreply.github.com>
Date: Wed, 28 Oct 2020 13:23:48 +0800
Subject: [PATCH] :bulb: update regex docstring

---
 nonebot/rule.py | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/nonebot/rule.py b/nonebot/rule.py
index fed21d70..6694c2b2 100644
--- a/nonebot/rule.py
+++ b/nonebot/rule.py
@@ -234,7 +234,9 @@ def command(command: Tuple[str, ...]) -> Rule:
 def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule:
     """
     :说明:
-      根据正则表达式进行匹配
+      根据正则表达式进行匹配。
+      
+      可以通过 ``state["matched"]`` 获取正则表达式匹配成功的文本。
     :参数:
       * ``regex: str``: 正则表达式
       * ``flags: Union[int, re.RegexFlag]``: 正则标志
@@ -247,9 +249,9 @@ def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule:
     pattern = re.compile(regex, flags)
 
     async def _regex(bot: Bot, event: Event, state: dict) -> bool:
-        matched_string = pattern.search(str(event.message))
-        if matched_string:
-            state["matched_string"] = matched_string.group()
+        matched = pattern.search(str(event.message))
+        if matched:
+            state["matched"] = matched.group()
             return True
         else:
             return False