proofread and fix the docs for relations

Author: collerek

docs/relations/foreign-key.md

@@ -45,7 +45,7 @@ But you cannot:
 
 * Access the related field from reverse model with `related_name`
 * Even if you `select_related` from reverse side of the model the returned models won't be populated in reversed instance (the join is not prevented so you still can `filter` and `order_by` over the relation)
-* The relation won't be populated in `model_dump()` and `json()`
+* The relation won't be populated in `model_dump()` and `model_dump_json()`
 * You cannot pass the nested related objects when populating from dictionary or json (also through `fastapi`). It will be either ignored or error will be raised depending on `extra` setting in pydantic `Config`.
 
 Example:
@@ -110,7 +110,7 @@ assert department.courses[0] == course
 !!!warning
     If you want to add child model on related model the primary key value for parent model **has to exist in database**.
 
-    Otherwise ormar will raise RelationshipInstanceError as it cannot set child's ForeignKey column value 
+    Otherwise ormar will raise `RelationshipInstanceError` as it cannot set child's ForeignKey column value 
     if parent model has no primary key value.
 
     That means that in example above the department has to be saved before you can call `department.courses.add()`.
@@ -149,7 +149,7 @@ await department.courses.remove(course, keep_reversed=False)
 
 Removal of all related models in one call.
 
-Like remove by default `clear()` nulls the ForeigKey column on child model (all, not matter if they are loaded or not).
+Like with remove, by default, `clear()` nulls the ForeigKey column on child model (all, not matter if they are loaded or not).
 
 ```python
 # nulls department column on all courses related to this department
@@ -171,7 +171,7 @@ To read which methods of QuerySet are available read below [querysetproxy][query
 
 ## related_name
 
-But you can overwrite this name by providing `related_name` parameter like below:
+You can overwrite related model field name by providing `related_name` parameter like below:
 
 ```Python hl_lines="27-29 35"
 --8<-- "../docs_src/fields/docs002.py"

docs/relations/index.md

@@ -26,7 +26,7 @@ The definition of one-to-many relation also uses `ForeignKey`, and it's register
 
 So in relation to example above.
 
-```Python hl_lines="8"
+```Python hl_lines="7-8"
 class Department(ormar.Model):
     ormar_config = base_ormar_config.copy()
 
@@ -50,7 +50,7 @@ class Department(ormar.Model):
 
 To define many-to-many relation use `ManyToMany` field.
 
-```python hl_lines="18"
+```python hl_lines="19"
 class Category(ormar.Model):
     ormar_config = ormar.OrmarConfig(
         database=database,
@@ -91,7 +91,7 @@ side of the current query for m2m models.
 So if you query from model `A` to model `B`, only model `B` has through field exposed.
 Which kind of make sense, since it's a one through model/field for each of related models.
 
-```python hl_lines="12-20"
+```python hl_lines="12-21"
 class Category(ormar.Model):
     ormar_config = ormar.OrmarConfig(
         database=database,

docs/relations/many-to-many.md

@@ -24,9 +24,9 @@ news = await Category.objects.create(name="News")
 
 `ForeignKey` fields are automatically registering reverse side of the relation.
 
-By default it's child (source) `Model` name + s, like courses in snippet below: 
+By default it's child (source) `Model` name + s, like `posts` in snippet below: 
 
-```python
+```python hl_lines="25-26"
 class Category(ormar.Model):
     ormar_config = base_ormar_config.copy(tablename="categories")
 
@@ -79,12 +79,14 @@ categories: Optional[Union[Category, List[Category]]] = ormar.ManyToMany(
 If you are sure you don't want the reverse relation you can use `skip_reverse=True` 
 flag of the `ManyToMany`.
 
-  If you set `skip_reverse` flag internally the field is still registered on the other 
-  side of the relationship so you can:
+If you set `skip_reverse` flag internally the field is still registered on the other 
+side of the relationship so you can:
+
   * `filter` by related models fields from reverse model
   * `order_by` by related models fields from reverse model 
 
-  But you cannot:
+But you cannot:
+
   * access the related field from reverse model with `related_name`
   * even if you `select_related` from reverse side of the model the returned models won't be populated in reversed instance (the join is not prevented so you still can `filter` and `order_by` over the relation)
   * the relation won't be populated in `model_dump()` and `json()`

docs/relations/postponed-annotations.md

@@ -14,21 +14,8 @@ First, you need to import the required ref from typing.
 from typing import ForwardRef
 ```
 
-But note that before python 3.7 it used to be internal, so for python <= 3.6 you need
-
-```python
-from typing import _ForwardRef as ForwardRef
-```
-
-or since `pydantic` is required by `ormar` it can handle this switch for you. 
-In that case you can simply import ForwardRef from pydantic regardless of your python version.
-
-```python
-from pydantic.typing import ForwardRef
-```
-
 Now we need a sample model and a reference to the same model, 
-which will be used to creat a self referencing relation.
+which will be used to create a self referencing relation.
 
 ```python
 # create the forwardref to model Person

docs/relations/queryset-proxy.md

@@ -58,7 +58,7 @@ assert post.categories[0] == news
 
 `get_or_create(_defaults: Optional[Dict[str, Any]] = None, **kwargs) -> Tuple[Model, bool]`
 
-Tries to get a row meeting the criteria and if NoMatch exception is raised it creates a new one with given kwargs and _defaults.
+Tries to get a row meeting the criteria and if `NoMatch` exception is raised it creates a new one with given kwargs and _defaults.
 
 !!!tip
     Read more in queries documentation [get_or_create][get_or_create]

mkdocs.yml

@@ -16,10 +16,10 @@ nav:
     - Pydantic only fields: fields/pydantic-fields.md
     - Fields encryption: fields/encryption.md
   - Relations:
-    - relations/index.md
-    - relations/postponed-annotations.md
+    - Relation types: relations/index.md
     - relations/foreign-key.md
     - relations/many-to-many.md
+    - relations/postponed-annotations.md
     - relations/queryset-proxy.md
   - Queries:
     - queries/index.md