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

📝 Add note about sections, achievable with `extra`

This commit is contained in:
Sebastián Ramírez 2022-12-20 17:11:25 +04:00 committed by GitHub
parent 094744c2fe
commit 89c6e4b56f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
typing_doc.md
View File

@ -183,7 +183,7 @@ Other possible features that could be added in the future, probably in the form
* `**kwargs`: some form of documenting additional keyword arguments defined with `**kwargs` instead of using the independent parameters in the function/callable signature.
* Generators: a way to document the types of values yielded by a generator.
* Warnings: a way to document the possible warnings that a function or method can create.
* Section titles: a way to separate groups of parameters into sections (or tags), mainly for documentation purposes, if that was included, it could make sense to also support a way to define the order of sections and their descriptions.
* Section titles: a way to separate groups of parameters into sections (or tags), mainly for documentation purposes, if that was included, it could make sense to also support a way to define the order of sections and their descriptions. Although this might be achievable using the current `extra` parameter for extensions.
### Duplicated Effort