From: Timothée Mazzucotelli Date: Mon, 28 Aug 2023 12:48:16 +0000 (+0200) Subject: ✏️ Fix typos in `typing_doc` page (#10162) X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f7feb0fa48c29cf84cd6d554404a472fad4787a6;p=thirdparty%2Ffastapi%2Ffastapi.git ✏️ Fix typos in `typing_doc` page (#10162) --- diff --git a/typing_doc.md b/typing_doc.md index e8cc1f0055..97eff22d1f 100644 --- a/typing_doc.md +++ b/typing_doc.md @@ -113,7 +113,7 @@ When creating a type alias, like: 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: @@ -127,7 +127,7 @@ def hi(to: Username) -> 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