docs: update PyDoc

PEP 257 -- Docstring Conventions https://www.python.org/dev/peps/pep-0257/ PEP 8 -- Style Guide for Python Code https://www.python.org/dev/peps/pep-0008/ [skip ci]
johnnymillergh · Nov 11, 2021 · e8a5292 · e8a5292
1 parent b254d41
commit e8a5292
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/home_guardian/common/debounce_throttle.py b/home_guardian/common/debounce_throttle.py
@@ -9,9 +9,9 @@ def debounce(interval: float):
     Decorator that will postpone a functions
     execution until after wait seconds
     have elapsed since the last time it was invoked.
+    https://gist.github.com/walkermatt/2871026
 
-    @param interval: interval time in seconds
-    @see https://gist.github.com/walkermatt/2871026
+    :param interval: interval time in seconds
     """
 
     def decorator(fn):
@@ -47,10 +47,10 @@ def set(self, v):
 def throttle(interval: float):
     """
     Throttle decorator.
+    Python 中的防抖与节流 https://www.bilibili.com/read/cv13257868/
+    Python 中的防抖与节流 https://www.moyu.moe/articles/25/
 
-    @param interval: interval time in seconds
-    @see Python 中的防抖与节流 https://www.bilibili.com/read/cv13257868/
-    @see Python 中的防抖与节流 https://www.moyu.moe/articles/25/
+    :param interval: interval time in seconds
     """
 
     # 下一次许可调用的时间，初始化为 0

diff --git a/home_guardian/repository/model/base/model.py b/home_guardian/repository/model/base/model.py
@@ -12,8 +12,7 @@
 class BaseModel(Model):
     """
     Base model for persistence.
-
-    @see Models and Fields https://docs.peewee-orm.com/en/latest/peewee/models.html#model-inheritance
+    Models and Fields https://docs.peewee-orm.com/en/latest/peewee/models.html#model-inheritance
     """
 
     class Meta: