From 901514e32bb9b22c0a37acd69f6f54e3cf4efb95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Mon, 5 Dec 2022 21:16:08 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20note=20about=20early=20ado?= =?UTF-8?q?pters=20on=20Alternate=20Form?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- typing_doc.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/typing_doc.md b/typing_doc.md index af6995b07..84554828b 100644 --- a/typing_doc.md +++ b/typing_doc.md @@ -150,6 +150,8 @@ def __typing_doc__( And then they can use it in the same places they would use `doc()`. +This alternate form can be used by early adopters including libraries, linters, editors, type checkers, documentation generation tools and others. + **Note**: this mimics and blatantly copies the pattern from the early versions of the [`dataclass_transform` specification](https://github.com/microsoft/pyright/blob/main/specs/dataclass_transforms.md#alternate-form). ## Rejected Ideas