Skip to content

Commit 5270a4b

Browse files
authored
📝 Add mention to griffe-typingdoc (#10)
1 parent e9bc38c commit 5270a4b

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
@@ -58,13 +58,15 @@ The same way, you could document return types and variables, or anything that co
5858

5959
## Who Uses This
6060

61-
This was made for:
61+
`annotated-doc` was made for:
6262

6363
* [FastAPI](https://fastapi.tiangolo.com/)
6464
* [Typer](https://typer.tiangolo.com/)
6565
* [SQLModel](https://sqlmodel.tiangolo.com/)
6666
* [Asyncer](https://asyncer.tiangolo.com/)
6767

68+
`annotated-doc` is supported by [griffe-typingdoc](https://github.com/mkdocstrings/griffe-typingdoc), which powers reference documentation like the one in the [FastAPI Reference](https://fastapi.tiangolo.com/reference/).
69+
6870
## Reasons not to use `annotated-doc`
6971

7072
You are already comfortable with one of the existing docstring formats, like:

0 commit comments

Comments
 (0)