From 6f1ffccd4f7a32d61e97290b58f237c28c496b89 Mon Sep 17 00:00:00 2001 From: =?utf8?q?M=C3=A5ns=20Magnusson?= Date: Sat, 27 Aug 2022 22:50:33 +0200 Subject: [PATCH] =?utf8?q?=E2=9C=8F=20Fix=20typos=20in=20`docs/tutorial/co?= =?utf8?q?de-structure.md`,=20`docs/tutorial/fastapi/multiple-models.md`,?= =?utf8?q?=20`docs/tutorial/fastapi/simple-hero-api.md`,=20`docs/tutorial/?= =?utf8?q?many-to-many/index.md`=20(#116)?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Co-authored-by: moonso Co-authored-by: Sebastián Ramírez --- docs/tutorial/code-structure.md | 2 +- docs/tutorial/fastapi/multiple-models.md | 2 +- docs/tutorial/many-to-many/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/code-structure.md b/docs/tutorial/code-structure.md index 31698a48..f46dc1e4 100644 --- a/docs/tutorial/code-structure.md +++ b/docs/tutorial/code-structure.md @@ -170,7 +170,7 @@ Let's assume that now the file structure is: The problem with circular imports is that Python can't resolve them at *runtime*. -but when using Python **type annotations** it's very common to need to declare the type of some variables with classes imported from other files. +But when using Python **type annotations** it's very common to need to declare the type of some variables with classes imported from other files. And the files with those classes might **also need to import** more things from the first files. diff --git a/docs/tutorial/fastapi/multiple-models.md b/docs/tutorial/fastapi/multiple-models.md index d313874c..3643ec8f 100644 --- a/docs/tutorial/fastapi/multiple-models.md +++ b/docs/tutorial/fastapi/multiple-models.md @@ -361,7 +361,7 @@ And because we can't leave the empty space when creating a new class, but we don This means that there's nothing else special in this class apart from the fact that it is named `HeroCreate` and that it inherits from `HeroBase`. -As an alternative, we could use `HeroBase` directly in the API code instead of `HeroCreate`, but it would show up in the auomatic docs UI with that name "`HeroBase`" which could be **confusing** for clients. Instead, "`HeroCreate`" is a bit more explicit about what it is for. +As an alternative, we could use `HeroBase` directly in the API code instead of `HeroCreate`, but it would show up in the automatic docs UI with that name "`HeroBase`" which could be **confusing** for clients. Instead, "`HeroCreate`" is a bit more explicit about what it is for. On top of that, we could easily decide in the future that we want to receive **more data** when creating a new hero apart from the data in `HeroBase` (for example a password), and now we already have the class to put those extra fields. diff --git a/docs/tutorial/many-to-many/index.md b/docs/tutorial/many-to-many/index.md index 24d7824f..e2e34777 100644 --- a/docs/tutorial/many-to-many/index.md +++ b/docs/tutorial/many-to-many/index.md @@ -60,7 +60,7 @@ Notice that each hero can only have **one** connection. But each team can receiv ## Introduce Many-to-Many -But let's say that as **Deadpond** is a great chracter, they recruit him to the new **Preventers** team, but he's still part of the **Z-Force** team too. +But let's say that as **Deadpond** is a great character, they recruit him to the new **Preventers** team, but he's still part of the **Z-Force** team too. So, now, we need to be able to have a hero that is connected to **many** teams. And then, each team, should still be able to receive **many** heroes. So we need a **Many-to-Many** relationship. -- 2.47.2