Skip to content

Commit 2b2e40f

Browse files
committed
docs: Mention the new annotated-doc package from tiangolo
1 parent 40a5d3e commit 2b2e40f

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@
55
[![pypi version](https://img.shields.io/pypi/v/griffe-typingdoc.svg)](https://pypi.org/project/griffe-typingdoc/)
66
[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe-typingdoc:gitter.im)
77

8-
Griffe extension for [PEP 727 – Documentation Metadata in Typing](https://peps.python.org/pep-0727/).
8+
Griffe extension for [`annotated-doc`](https://pypi.org/project/annotated-doc/) (originally [PEP 727](https://peps.python.org/pep-0727/)):
9+
10+
> Document parameters, class attributes, return types, and variables inline, with Annotated.
911
1012
## Installation
1113

1214
```bash
1315
pip install griffe-typingdoc
1416
```
1517

16-
To use the extension in a MkDocs project,
17-
use this configuration:
18+
To use the extension in a MkDocs project, use this configuration:
1819

1920
```yaml
2021
# mkdocs.yml

docs/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ hide:
2222
## Enhanced
2323

2424
> WARNING: **Non-standard features**
25-
The "enhanced" features are not part of PEP 727.
25+
The "enhanced" features are not part of `annotated-doc` or PEP 727.
2626
They just serve as an example to show what would be possible
27-
if the PEP was enhanced to account for more use-cases.
27+
if the package or PEP were enhanced to account for more use-cases.
2828

2929
/// details | `enhanced` Python module
3030
type: example

src/griffe_typingdoc/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""Griffe TypingDoc package.
22
3-
Griffe extension for PEP 727 - Documentation Metadata in Typing.
3+
Griffe extension for `annotated-doc` (originally PEP 727):
4+
5+
> Document parameters, class attributes, return types, and variables inline, with Annotated.
46
"""
57

68
# TODO: Set parameter docstrings?

0 commit comments

Comments
 (0)