Skip to content

Commit cf673b7

Browse files
authored
📝 Update README with use cases (#9)
1 parent f856e73 commit cf673b7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ class User:
5454
age: Annotated[int, Doc("The user's age")]
5555
```
5656

57+
The same way, you could document return types and variables, or anything that could have a type annotation with `Annotated`.
58+
5759
## Who Uses This
5860

5961
This was made for:
@@ -98,7 +100,7 @@ I ([@tiangolo](https://github.com/tiangolo)) originally wanted for this to be pa
98100

99101
The conclusion was that this was better done as an external effort, in a third-party library.
100102

101-
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.
103+
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.
102104

103105
## License
104106

0 commit comments

Comments
 (0)