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.

Sign up for GitHub

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

Jump to bottom

✏ Fix minor typos in docs/en/docs/async.md #5125

Merged
merged 2 commits into from Aug 26, 2022
Merged

✏ Fix minor typos in docs/en/docs/async.md #5125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bb4f45
Make minor corrections
Ksenofanex Jul 12, 2022
c37b693
Merge branch 'master' into async-docs-fixes
tiangolo Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/en/docs/async.md
View file
Open in desktop
Expand Up @@ -26,7 +26,7 @@ async def read_results():

---

If you are using a third party library that communicates with something (a database, an API, the file system, etc) and doesn't have support for using `await`, (this is currently the case for most database libraries), then declare your *path operation functions* as normally, with just `def`, like:
If you are using a third party library that communicates with something (a database, an API, the file system, etc.) and doesn't have support for using `await`, (this is currently the case for most database libraries), then declare your *path operation functions* as normally, with just `def`, like:

```Python hl_lines="2"
@app.get('/')
Expand All @@ -45,7 +45,7 @@ If you just don't know, use normal `def`.

---

**Note**: you can mix `def` and `async def` in your *path operation functions* as much as you need and define each one using the best option for you. FastAPI will do the right thing with them.
**Note**: You can mix `def` and `async def` in your *path operation functions* as much as you need and define each one using the best option for you. FastAPI will do the right thing with them.

Anyway, in any of the cases above, FastAPI will still work asynchronously and be extremely fast.

Expand Down Expand Up @@ -397,7 +397,7 @@ All that is what powers FastAPI (through Starlette) and what makes it have such

These are very technical details of how **FastAPI** works underneath.

If you have quite some technical knowledge (co-routines, threads, blocking, etc) and are curious about how FastAPI handles `async def` vs normal `def`, go ahead.
If you have quite some technical knowledge (co-routines, threads, blocking, etc.) and are curious about how FastAPI handles `async def` vs normal `def`, go ahead.

### Path operation functions

Expand Down