happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

✏️ Fix typos in `typing_doc` page (#10162)

This commit is contained in:
Timothée Mazzucotelli 2023-08-28 14:48:16 +02:00 committed by GitHub
parent b13ed4c578
commit f7feb0fa48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
typing_doc.md
View File

@ -113,7 +113,7 @@ When creating a type alias, like:
Username = Annotated[str, doc("The name of a user in the system")] Username = Annotated[str, doc("The name of a user in the system")]
``` ```
...the documentation would be considered to be carried by the parameter annotated with `Foo`. ...the documentation would be considered to be carried by the parameter annotated with `Username`.
So, in a function like: So, in a function like:
@ -127,7 +127,7 @@ def hi(to: Username) -> None: ...
def hi(to: Annotated[str, doc("The name of a user in the system")]) -> None: ... def hi(to: Annotated[str, doc("The name of a user in the system")]) -> None: ...
``` ```
Nevertheless, implementers would not be required to support type aliases outside of the final type annotation to be conformant with this specification, as it could require more complex derefrenecing logic. Nevertheless, implementers would not be required to support type aliases outside of the final type annotation to be conformant with this specification, as it could require more complex dereferencing logic.
#### Annotating Type Parameters #### Annotating Type Parameters