From 3dbdc743666c8b8eadd3e982a89513e838be9ffd Mon Sep 17 00:00:00 2001 From: nukopy Date: Fri, 6 Nov 2020 07:33:06 +0900 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=20Fix=20typos=20and=20add=20rewording?= =?UTF-8?q?=20in=20docs=20(#2159)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: fix typo in chapter "Request Body" in "Tutorial - User Guide" * docs: modify a sentence in chapter "Query Parameters and String Validations" in "Tutorial - User Guide" * docs: fix two grammatical mistakes in chapter "Path Parameters and Numeric Validations" in "Tutorial - User Guide" --- docs/en/docs/tutorial/body.md | 2 +- docs/en/docs/tutorial/path-params-numeric-validations.md | 2 +- docs/en/docs/tutorial/query-params-str-validations.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/docs/tutorial/body.md b/docs/en/docs/tutorial/body.md index 2afc97998..24b228596 100644 --- a/docs/en/docs/tutorial/body.md +++ b/docs/en/docs/tutorial/body.md @@ -131,7 +131,7 @@ Inside of the function, you can access all the attributes of the model object di ## Request body + path parameters -You can declare path parameters and body requests at the same time. +You can declare path parameters and request body at the same time. **FastAPI** will recognize that the function parameters that match path parameters should be **taken from the path**, and that function parameters that are declared to be Pydantic models should be **taken from the request body**. diff --git a/docs/en/docs/tutorial/path-params-numeric-validations.md b/docs/en/docs/tutorial/path-params-numeric-validations.md index 1fcd9dbdb..5da69a21b 100644 --- a/docs/en/docs/tutorial/path-params-numeric-validations.md +++ b/docs/en/docs/tutorial/path-params-numeric-validations.md @@ -106,7 +106,7 @@ And you can also declare numeric validations: * `le`: `l`ess than or `e`qual !!! info - `Query`, `Path` and others you will see later subclasses of a common `Param` class (that you don't need to use). + `Query`, `Path`, and others you will see later are subclasses of a common `Param` class (that you don't need to use). And all of them share the same all these same parameters of additional validation and metadata you have seen. diff --git a/docs/en/docs/tutorial/query-params-str-validations.md b/docs/en/docs/tutorial/query-params-str-validations.md index 4edb4f597..8deccda0b 100644 --- a/docs/en/docs/tutorial/query-params-str-validations.md +++ b/docs/en/docs/tutorial/query-params-str-validations.md @@ -17,7 +17,7 @@ The query parameter `q` is of type `Optional[str]`, that means that it's of type ## Additional validation -We are going to enforce that even though `q` is optional, whenever it is provided, it **doesn't exceed a length of 50 characters**. +We are going to enforce that even though `q` is optional, whenever it is provided, **its length doesn't exceed 50 characters**. ### Import `Query`