From 945be7cf010715246fff3f3074ab3d8722989da2 Mon Sep 17 00:00:00 2001 From: prrao87 Date: Thu, 26 Aug 2021 14:48:02 -0400 Subject: [PATCH 1/3] More typo and style fixes --- docs/databases.md | 14 +++++++------- docs/tutorial/index.md | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/databases.md b/docs/databases.md index cb085c67d2..90d9935807 100644 --- a/docs/databases.md +++ b/docs/databases.md @@ -99,9 +99,9 @@ Having distributed systems also creates additional challenges, so there's a high We already talked about the different ways to interact with a database and how they handle files, etc. That applies to most or all of the databases. -But there's another way to categorize databases that is very important. As you can imagine, there are many types of databases and many databases in each group. But in general, they can be separated in two big groups: "SQL Databases" and "NoSQL Databases". +But there's another way to categorize databases that is very important. As you can imagine, there are many types of databases and many databases in each group. But in general, they can be separated in two big groups: **SQL** databases and **NoSQL** databases. -We will get to why the name "SQL" in a bit, but first, let's see what is it all about. +We will get to why the name is "SQL" in a bit, but first, let's see what is it all about. ### SQLModel for SQL Databases @@ -264,17 +264,17 @@ It doesn't have the meaning that you would use in English of something being rel The technical term **relation** just refers to each one of these tables. -And because of this technical term, these **SQL Databases** are also called **Relational Databases** (in fact, that is the technically correct term). But it still just refers to these databases made with multiple tables. +And because of this technical term, these **SQL Databases** are also called **Relational Databases** (in fact, that is the technically correct term). But it still just refers to these as databases made with multiple tables. ### SQL - The Language -After developing these ideas of how to store data in multiple tables they also created a **language** that could be used to interact with them. +After developing these ideas of how to store data in multiple tables, the same smart people also created a **language** that could be used to interact with them. -The language is called **SQL**, the name comes from for **Structured Query Language**. +The language is called **SQL**, which stands for **Structured Query Language**. -Nevertheless, the language is not only used to *query* for data. It is also used to create records/rows, to update them, to delete them. And to manipulate the database, create tables, etc. +Despite its name, the SQL language is not only used to *query* for data. It is also used to create records/rows, update them, delete them, manipulate the database, create tables, etc. -This language is supported by all these databases that handle multiple tables, that's why they are called **SQL Databases**. Although, each database has small variations in the SQL language they support. +Because this language is supported by all these databases that handle multiple tables, they are called **SQL Databases**. However, it's important to note that each database has small variations in the SQL language (*dialect*) they support. Let's imagine that the table holding the heroes is called the `hero` table. An example of a SQL query to get all the data from it could look like: diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md index 6deb258802..07540cacb6 100644 --- a/docs/tutorial/index.md +++ b/docs/tutorial/index.md @@ -2,11 +2,11 @@ ## Type hints -If you need a refreshed about how to use Python type hints (type annotations), check FastAPI's Python types intro. +If you need a refresher about how to use Python type hints (type annotations), check FastAPI's Python types intro. You can also check the mypy cheat sheet. -**SQLModel** uses type annotations for everything, this way you can use a familiar Python syntax and get all the editor support posible, with autocompletion and in-editor error checking. +**SQLModel** uses type annotations for everything, this way you can use a familiar Python syntax and get all the editor support possible, with autocompletion and in-editor error checking. ## Intro From 3371a3e4ebcf4ed1ba17b389e107f2c25f2d0632 Mon Sep 17 00:00:00 2001 From: prrao87 Date: Thu, 26 Aug 2021 14:50:02 -0400 Subject: [PATCH 2/3] Fix typo mentioned in comment in #5 --- docs/tutorial/fastapi/simple-hero-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/fastapi/simple-hero-api.md b/docs/tutorial/fastapi/simple-hero-api.md index 8759bce2c2..8676136a46 100644 --- a/docs/tutorial/fastapi/simple-hero-api.md +++ b/docs/tutorial/fastapi/simple-hero-api.md @@ -152,7 +152,7 @@ It will be called when a user sends a request with a `POST` **operation** to the ## The **SQLModel** Advantage -Here's where having our **SQLModel** class models be both **SQLAlchemy** models and **Pydantic** models at the same tieme shine. ✨ +Here's where having our **SQLModel** class models be both **SQLAlchemy** models and **Pydantic** models at the same time shine. ✨ Here we use the **same** class model to define the **request body** that will be received by our API. From fe4c541e5ec4e49757a076752b5c93729499e1ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Sat, 27 Aug 2022 23:34:10 +0200 Subject: [PATCH 3/3] =?UTF-8?q?=E2=8F=AA=20Revert=20purely=20stylistic=20c?= =?UTF-8?q?hanges=20that=20depend=20mainly=20on=20taste,=20keep=20typo=20f?= =?UTF-8?q?ixes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/databases.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/databases.md b/docs/databases.md index 48ac9ef5db..f1aaf663ab 100644 --- a/docs/databases.md +++ b/docs/databases.md @@ -99,9 +99,9 @@ Having distributed systems also creates additional challenges, so there's a high We already talked about the different ways to interact with a database and how they handle files, etc. That applies to most or all of the databases. -But there's another way to categorize databases that is very important. As you can imagine, there are many types of databases and many databases in each group. But in general, they can be separated in two big groups: **SQL** databases and **NoSQL** databases. +But there's another way to categorize databases that is very important. As you can imagine, there are many types of databases and many databases in each group. But in general, they can be separated in two big groups: "SQL Databases" and "NoSQL Databases". -We will get to why the name is "SQL" in a bit, but first, let's see what is it all about. +We will get to why the name "SQL" in a bit, but first, let's see what is it all about. ### SQLModel for SQL Databases @@ -264,17 +264,17 @@ It doesn't have the meaning that you would use in English of something being rel The technical term **relation** just refers to each one of these tables. -And because of this technical term, these **SQL Databases** are also called **Relational Databases** (in fact, that is the technically correct term). But it still just refers to these as databases made with multiple tables. +And because of this technical term, these **SQL Databases** are also called **Relational Databases** (in fact, that is the technically correct term). But it still just refers to these databases made with multiple tables. ### SQL - The Language -After developing these ideas of how to store data in multiple tables, the same smart people also created a **language** that could be used to interact with them. +After developing these ideas of how to store data in multiple tables they also created a **language** that could be used to interact with them. -The language is called **SQL**, which stands for **Structured Query Language**. +The language is called **SQL**, the name comes from for **Structured Query Language**. -Despite its name, the SQL language is not only used to *query* for data. It is also used to create records/rows, update them, delete them, manipulate the database, create tables, etc. +Nevertheless, the language is not only used to *query* for data. It is also used to create records/rows, to update them, to delete them. And to manipulate the database, create tables, etc. -Because this language is supported by all these databases that handle multiple tables, they are called **SQL Databases**. However, it's important to note that each database has small variations in the SQL language (*dialect*) they support. +This language is supported by all these databases that handle multiple tables, that's why they are called **SQL Databases**. Although, each database has small variations in the SQL language they support (*dialect*). Let's imagine that the table holding the heroes is called the `hero` table. An example of a SQL query to get all the data from it could look like: