From: Bob Halley <halley@dnspython.org>
Date: Mon, 31 Aug 2020 15:03:24 +0000 (-0700)
Subject: add a note on type annotations
X-Git-Tag: v2.1.0rc1~28
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=674cdfc8ba30e12810645eee4531c943518abc16;p=thirdparty%2Fdnspython.git

add a note on type annotations
---

diff --git a/doc/manual.rst b/doc/manual.rst
index b82b7e1c..ecf41673 100644
--- a/doc/manual.rst
+++ b/doc/manual.rst
@@ -15,3 +15,4 @@ Dnspython Manual
    async
    exceptions
    utilities
+   typing
diff --git a/doc/typing.rst b/doc/typing.rst
new file mode 100644
index 00000000..1325f10e
--- /dev/null
+++ b/doc/typing.rst
@@ -0,0 +1,10 @@
+.. _typing:
+
+A Note on Typing
+----------------
+
+Dnspython has partial support for type annotations in separate .pyi
+files.  Type information will not be integrated into the main files
+until major LTS versions of various Linux distributions containing 3.6
+are beyond their support times.  Improvements to the .pyi files are
+welcome during this time.