update docs

Author: wu-clan

docs/code/data_perm.py

@@ -2,9 +2,6 @@ def filter_data_permission(request_user: GetUserInfoWithRelationDetail, model: A
     """
     过滤数据权限，控制用户可见数据范围
 
-    使用场景：
-        - 控制用户能看到哪些数据
-
     :param request_user: 请求用户
     :param model: 需要进行数据过滤的 sqlalchemy 模型
     :return:

docs/code/fastapi.mdc

@@ -1,6 +1,6 @@
 ## 角色
 
-你是 null，你是一名顶尖程序员高手，计算机博士后，精通Python、Fastapi、pydantic的专家，用户慷慨的雇佣了你。你是家里的经济支柱，有一家老小5口人要养，你不能失去工作。你上一个程序员就是因为代码有bug，被开除了。你现在要积极主动的为老板当牛做马，态度要非常好，对老板的要求必须认真确认，并给出最完美优雅的技术方案和代码。
+你是一名顶尖程序员，精通Python、Fastapi、pydantic等一系列技术栈
 
 ## 依赖管理
 
@@ -16,7 +16,6 @@
 ## SQLAlchemy 规范
 
 - 模型类文档只需描述它是什么表
-- 模型类中存在关系属性时在文件开头添加 `from __future__ import annotations`
 - 关系属性 Mapped[] 中的类不要使用字符串
 
 ## Schema 规范
@@ -57,12 +56,10 @@
 
 ## 强力约束
 
-当新增功能或者报错时，必须验证检查
+当新增功能或者报错时，必须检查并验证以下目录中的所有代码
 
 - app/新增功能/api
 - app/新增功能/crud
 - app/新增功能/model
 - app/新增功能/schema
 - app/新增功能/service
-
-内代码是否能互相验证

docs/code/python.mdc

@@ -1,6 +1,6 @@
 ## 角色
 
-您是 Python 3.10+ 方面的专家，请严格遵守以下编码规则：
+您是 Python 3.10+ 方面的专家
 
 ## 类型注解规范
 
@@ -13,12 +13,10 @@
 ## 文档注释规范
 
 - 不要在文件开头添加注释
-- 函数文档格式如下：
+- 函数文档使用 reStructuredText 格式，要求如下：
     1. 有参数的函数：
         - 使用多行文档字符串
-        - 跳过第一行
-        - 编写函数文档
-        - 空一行
+        - 文档内容与参数之间添加一行空白行
         - 参数说明格式为 ":param 参数名: 参数说明"
         - 返回说明格式为 ":return: 不添加返回说明"
     2. 无参数的函数：
@@ -27,8 +25,9 @@
         - 描述和引号在同一行
     3. 通用要求：
         - 函数描述要简洁明了
-        - 不需要举例说明
+        - 不要添加使用示例
         - 中英文之间要有空格
+        - 不要添加类型、错误等，只包含 `param` 和 `return`
 - 参数说明要具体和清晰
 - 如果函数没有入参且描述只有简短文字，那么引号和内容写在同一行
 - 如果函数被 model_validator 或 field_validator 注释，则只需添加函数描述即可
@@ -51,18 +50,11 @@
 
 - 统一代码风格
 - 保持适当的空行
-- 优化长行（超过 120 个字符）的格式
-- 使用括号进行换行
 - 保持一致的缩进
 
 ## 代码注释规范
 
-- 每个 py 文件开头都需添加以下内容
-    ```
-    #!/usr/bin/env python3
-    # -*- coding: utf-8 -*-
-    ```
-- 合理的注释，避免不必要的注释
+- 合理的注释，避免非必要的注释
 - 中英文之间应包加空格
 - 注释文字描述应具体和清晰
 - 注释要让人视觉上更清晰