From 8dbf3494878c28c0e125a4e9174ba32fdad45f62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Wed, 22 Oct 2025 20:53:53 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README=20with=20use=20c?= =?UTF-8?q?ases?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 765120b..b8aaf08 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,8 @@ class User: age: Annotated[int, Doc("The user's age")] ``` +The same way, you could document return types and variables, or anything that could have a type annotation with `Annotated`. + ## Who Uses This This was made for: @@ -98,7 +100,7 @@ I ([@tiangolo](https://github.com/tiangolo)) originally wanted for this to be pa The conclusion was that this was better done as an external effort, in a third-party library. -So, here it is, with a simpler approach, as a third-party library, in a way that can be used by others, starting with FastAPI and friends, and its users. +So, here it is, with a simpler approach, as a third-party library, in a way that can be used by others, starting with FastAPI and friends. ## License