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

📝 Tweak doc structure for clarity and completeness

This commit is contained in:
Sebastián Ramírez 2022-12-20 00:00:49 +04:00
parent 9c116b4ed5
commit d80a8fce5f
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
typing_doc.md
View File

@ -125,7 +125,7 @@ def utcnow() -> datetime:
## Alternate Form
To avoid delaying adoption of this proposal until after the `doc()` function has been added to the typing module, type checkers may support an alternative form `__typing_doc__`. This form can be defined locally without any reliance on the `typing` or `typing_extensions` modules. It allows immediate adoption of the specification by library authors. Type checkers that have not yet adopted this specification will retain their current behavior.
To avoid delaying adoption of this proposal until after the `doc()` function has been added to the typing module, type checkers and tools may support an alternative form `__typing_doc__`. This form can be defined locally without any reliance on the `typing` or `typing_extensions` modules. It allows immediate adoption of the specification by library authors. Type checkers that have not yet adopted this specification will retain their current behavior.
To use this alternate form, library authors should include the following declaration within their type stubs or source files.
@ -162,6 +162,8 @@ It wouldn't solve any of the other problems, like getting editor support (syntax
## Open Issues
### Runtime Behavior
Runtime behavior is still not defined. It would probably make sense to have an attribute `__typing_doc__` on the function, method, or class. `__doc__` is already reserved for docstrings.
For parameters, it could include the same object in the same `Annotated` type annotations.