Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos in docs #373

Merged
merged 1 commit into from
Mar 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Conversion is registered using `apischema.deserializer`/`apischema.serializer` f

When used as function decorator, the `Source`/`Target` types are directly extracted from the conversion function signature.

`serializer` can be called on methods/properties, in which case `Source` type is inferred to be th owning type.
`serializer` can be called on methods/properties, in which case `Source` type is inferred to be the owning type.

```python
{!conversions.py!}
Expand Down
2 changes: 1 addition & 1 deletion docs/data_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ With some teasing of features presented later:
```

!!! note
Field's metadata are just an ordinary `dict`; *apischema* provides some functions to enrich these metadata with its own keys (`alias("foo_bar)` is roughly equivalent to `{"_apischema_alias": "foo_bar"}) and use them when the time comes, but metadata are not reserved to *apischema* and other keys can be added.
Field's metadata are just an ordinary `dict`; *apischema* provides some functions to enrich these metadata with its own keys (`alias("foo_bar")` is roughly equivalent to `{"_apischema_alias": "foo_bar"}) and use them when the time comes, but metadata are not reserved to *apischema* and other keys can be added.

Because [PEP 584](https://www.python.org/dev/peps/pep-0584/) is painfully missing before Python 3.9, *apischema* metadata use their own subclass of `dict` just to add `|` operator for convenience in all Python versions.

Expand Down