Skip to content

Commit 32bb678

Browse files
Fix code review feedback: clarify async save_to and add context note
Co-authored-by: RobertoPrevato <2576032+RobertoPrevato@users.noreply.github.com>
1 parent 7797bd1 commit 32bb678

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

blacksheep/docs/openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ BlackSheep 2.6.0 adds full OpenAPI documentation support for `FromText` and `Fro
231231

232232
///
233233

234-
BlackSheep automatically generates OpenAPI documentation for various request body binders:
234+
BlackSheep automatically generates OpenAPI documentation for various request body binders. The following examples assume the `docs` handler has been set up as described in the [Built-in support](#built-in-support-for-openapi-documentation) section.
235235

236236
#### FromJSON
237237

blacksheep/docs/requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ The `FileBuffer` class wraps `SpooledTemporaryFile` and provides these methods:
415415
- `read(size: int = -1) -> bytes`: Read file content
416416
- `seek(offset: int, whence: int = 0) -> int`: Change file position
417417
- `close() -> None`: Close the file
418-
- `save_to(file_path: str) -> None`: Save file to disk (async)
418+
- `async save_to(file_path: str) -> None`: Asynchronously save file to disk (must be awaited)
419419

420420
```python
421421
from blacksheep import FromFiles, post

0 commit comments

Comments
 (0)