From 0f102ce0ef3dee37245e697199459fa8cc0ed575 Mon Sep 17 00:00:00 2001 From: xiongxinlei <915574300@qq.com> Date: Tue, 17 Sep 2024 16:17:56 +0800 Subject: [PATCH] fix zh docs's markdown syntax error --- docs/zh/docs/async.md | 12 +++++------ docs/zh/docs/how-to/index.md | 2 +- docs/zh/docs/python-types.md | 8 +++---- docs/zh/docs/tutorial/body.md | 8 +++---- docs/zh/docs/tutorial/first-steps.md | 8 +++---- docs/zh/docs/tutorial/index.md | 12 +++++------ docs/zh/docs/tutorial/path-params.md | 32 ++++++++++++++-------------- 7 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/zh/docs/async.md b/docs/zh/docs/async.md index 822ceeee4..6b572dbcf 100644 --- a/docs/zh/docs/async.md +++ b/docs/zh/docs/async.md @@ -56,7 +56,7 @@ def results(): ## 技术细节 -Python 的现代版本支持通过一种叫**"协程"**——使用 `async` 和 `await` 语法的东西来写**”异步代码“**。 +Python 的现代版本支持通过一种叫 **"协程"** ——使用 `async` 和 `await` 语法的东西来写 **"异步代码"**。 让我们在下面的部分中逐一介绍： @@ -285,7 +285,7 @@ CPU 密集型操作的常见示例是需要复杂的数学处理。 例如： -* **音频**或**图像**处理； +* **音频** 或 **图像** 处理； * **计算机视觉**: 一幅图像由数百万像素组成，每个像素有3种颜色值，处理通常需要同时对这些像素进行计算； * **机器学习**: 它通常需要大量的"矩阵"和"向量"乘法。想象一个包含数字的巨大电子表格，并同时将所有数字相乘； * **深度学习**: 这是机器学习的一个子领域，同样适用。只是没有一个数字的电子表格可以相乘，而是一个庞大的数字集合，在很多情况下，你需要使用一个特殊的处理器来构建和使用这些模型。 @@ -296,7 +296,7 @@ CPU 密集型操作的常见示例是需要复杂的数学处理。 并且，您也可以利用并行和多进程（让多个进程并行运行）的优点来处理与机器学习系统中类似的 **CPU 密集型** 工作。 -这一点，再加上 Python 是**数据科学**、机器学习（尤其是深度学习）的主要语言这一简单事实，使得 **FastAPI** 与数据科学/机器学习 Web API 和应用程序（以及其他许多应用程序）非常匹配。 +这一点，再加上 Python 是 **数据科学**、机器学习（尤其是深度学习）的主要语言这一简单事实，使得 **FastAPI** 与数据科学/机器学习 Web API 和应用程序（以及其他许多应用程序）非常匹配。 了解如何在生产环境中实现这种并行性，可查看此文 [Deployment](deployment/index.md){.internal-link target=_blank}。 @@ -385,7 +385,7 @@ Starlette （和 **FastAPI**） 是基于 I/O 的代码。 diff --git a/docs/zh/docs/how-to/index.md b/docs/zh/docs/how-to/index.md index ac097618b..d7e9ce265 100644 --- a/docs/zh/docs/how-to/index.md +++ b/docs/zh/docs/how-to/index.md @@ -8,6 +8,6 @@ /// tip | 小技巧 -如果你想以系统的方式**学习 FastAPI**（推荐），请阅读 [教程 - 用户指南](../tutorial/index.md){.internal-link target=_blank} 的每一章节。 +如果你想以系统的方式 **学习 FastAPI**（推荐），请阅读 [教程 - 用户指南](../tutorial/index.md){.internal-link target=_blank} 的每一章节。 /// diff --git a/docs/zh/docs/python-types.md b/docs/zh/docs/python-types.md index c78852539..6e691aa13 100644 --- a/docs/zh/docs/python-types.md +++ b/docs/zh/docs/python-types.md @@ -1,12 +1,12 @@ # Python 类型提示简介 -**Python 3.6+ 版本**加入了对"类型提示"的支持。 +**Python 3.6+ 版本** 加入了对"类型提示"的支持。 -这些**"类型提示"**是一种新的语法（在 Python 3.6 版本加入）用来声明一个变量的类型。 +这些 **"类型提示"** 是一种新的语法（在 Python 3.6 版本加入）用来声明一个变量的类型。 通过声明变量的类型，编辑器和一些工具能给你提供更好的支持。 -这只是一个关于 Python 类型提示的**快速入门 / 复习**。它仅涵盖与 **FastAPI** 一起使用所需的最少部分...实际上只有很少一点。 +这只是一个关于 Python 类型提示的 **快速入门 / 复习**。它仅涵盖与 **FastAPI** 一起使用所需的最少部分...实际上只有很少一点。 整个 **FastAPI** 都基于这些类型提示构建，它们带来了许多优点和好处。 @@ -242,7 +242,7 @@ John Doe Pydantic 是一个用来用来执行数据校验的 Python 库。 -你可以将数据的"结构"声明为具有属性的类。 +你可以将数据的 **"结构"** 声明为具有属性的类。 每个属性都拥有类型。 diff --git a/docs/zh/docs/tutorial/body.md b/docs/zh/docs/tutorial/body.md index c47abec77..5db223c3b 100644 --- a/docs/zh/docs/tutorial/body.md +++ b/docs/zh/docs/tutorial/body.md @@ -1,12 +1,12 @@ # 请求体 -FastAPI 使用**请求体**从客户端（例如浏览器）向 API 发送数据。 +FastAPI 使用 **请求体** 从客户端（例如浏览器）向 API 发送数据。 -**请求体**是客户端发送给 API 的数据。**响应体**是 API 发送给客户端的数据。 +**请求体** 是客户端发送给 API 的数据。**响应体** 是 `API` 发送给客户端的数据。 -API 基本上肯定要发送**响应体**，但是客户端不一定发送**请求体**。 +API 基本上肯定要发送 **响应体**，但是客户端不一定发送 **请求体**。 -使用 Pydantic 模型声明**请求体**，能充分利用它的功能和优点。 +使用 Pydantic 模型声明 **请求体**，能充分利用它的功能和优点。 /// info | "说明" diff --git a/docs/zh/docs/tutorial/first-steps.md b/docs/zh/docs/tutorial/first-steps.md index 779d1b8be..e09c38c24 100644 --- a/docs/zh/docs/tutorial/first-steps.md +++ b/docs/zh/docs/tutorial/first-steps.md @@ -188,7 +188,7 @@ $ uvicorn main:my_awesome_api --reload -### 步骤 3：创建一个*路径操作* +### 步骤 3：创建一个 *路径操作* #### 路径 @@ -249,7 +249,7 @@ https://example.com/items/foo 我们也打算称呼它们为「操作」。 -#### 定义一个*路径操作装饰器* +#### 定义一个 *路径操作装饰器* ```Python hl_lines="6" {!../../../docs_src/first_steps/tutorial001.py!} @@ -268,7 +268,7 @@ https://example.com/items/foo 装饰器接收位于其下方的函数并且用它完成一些工作。 -在我们的例子中，这个装饰器告诉 **FastAPI** 位于其下方的函数对应着**路径** `/` 加上 `get` **操作**。 +在我们的例子中，这个装饰器告诉 **FastAPI** 位于其下方的函数对应着 **路径** `/` 加上 `get` **操作**。 它是一个「**路径操作装饰器**」。 @@ -299,7 +299,7 @@ https://example.com/items/foo /// -### 步骤 4：定义**路径操作函数** +### 步骤 4：定义 **路径操作函数** 这是我们的「**路径操作函数**」： diff --git a/docs/zh/docs/tutorial/index.md b/docs/zh/docs/tutorial/index.md index ab19f02c5..811d6fcdb 100644 --- a/docs/zh/docs/tutorial/index.md +++ b/docs/zh/docs/tutorial/index.md @@ -58,13 +58,13 @@ $ pip install "fastapi[all]" 假如你想将应用程序部署到生产环境，你可能要执行以下操作： -``` +``` shell pip install fastapi ``` 并且安装`uvicorn`来作为服务器： -``` +``` shell pip install "uvicorn[standard]" ``` @@ -74,10 +74,10 @@ pip install "uvicorn[standard]" ## 进阶用户指南 -在本**教程-用户指南**之后，你可以阅读**进阶用户指南**。 +在本 **教程-用户指南** 之后，你可以阅读 **进阶用户指南**。 -**进阶用户指南**以本教程为基础，使用相同的概念，并教授一些额外的特性。 +**进阶用户指南** 以本教程为基础，使用相同的概念，并教授一些额外的特性。 -但是你应该先阅读**教程-用户指南**（即你现在正在阅读的内容）。 +但是你应该先阅读 **教程-用户指南**（即你现在正在阅读的内容）。 -教程经过精心设计，使你可以仅通过**教程-用户指南**来开发一个完整的应用程序，然后根据你的需要，使用**进阶用户指南**中的一些其他概念，以不同的方式来扩展它。 +教程经过精心设计，使你可以仅通过 **教程-用户指南** 来开发一个完整的应用程序，然后根据你的需要，使用 **进阶用户指南** 中的一些其他概念，以不同的方式来扩展它。 diff --git a/docs/zh/docs/tutorial/path-params.md b/docs/zh/docs/tutorial/path-params.md index 091dcbeb0..f6ad2852c 100644 --- a/docs/zh/docs/tutorial/path-params.md +++ b/docs/zh/docs/tutorial/path-params.md @@ -1,6 +1,6 @@ # 路径参数 -FastAPI 支持使用 Python 字符串格式化语法声明**路径参数**（**变量**）： +FastAPI 支持使用 Python 字符串格式化语法声明 **路径参数**（**变量**）： ```Python hl_lines="6-7" {!../../../docs_src/path_params/tutorial001.py!} @@ -113,13 +113,13 @@ FastAPI 充分地利用了 ### 使用 Python _枚举类型_ -*路径参数*的值是枚举的元素。 +*路径参数* 的值是枚举的元素。 -#### 比较*枚举元素* +#### 比较 *枚举元素* -枚举类 `ModelName` 中的*枚举元素*支持比较操作： +枚举类 `ModelName` 中的 *枚举元素* 支持比较操作： ```Python hl_lines="17" {!../../../docs_src/path_params/tutorial005.py!} ``` -#### 获取*枚举值* +#### 获取 *枚举值* -使用 `model_name.value` 或 `your_enum_member.value` 获取实际的值（本例中为**字符串**）： +使用 `model_name.value` 或 `your_enum_member.value` 获取实际的值（本例中为 **字符串**）： ```Python hl_lines="20" {!../../../docs_src/path_params/tutorial005.py!} @@ -195,9 +195,9 @@ Python 3.4 及之后版本支持解析** +- 数据 **解析** - 数据校验 - API 注解和 API 文档