summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2020-08-31 08:03:24 -0700
committerBob Halley <halley@dnspython.org>2020-08-31 08:03:24 -0700
commit674cdfc8ba30e12810645eee4531c943518abc16 (patch)
tree229ab18b5b0e072c8a6cad1db4463f728002dfbc
parentc5524f9cee3099ab2bf78c3606c2c18043a1c4b3 (diff)
downloaddnspython-674cdfc8ba30e12810645eee4531c943518abc16.tar.gz
add a note on type annotations
-rw-r--r--doc/manual.rst1
-rw-r--r--doc/typing.rst10
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/manual.rst b/doc/manual.rst
index b82b7e1..ecf4167 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 0000000..1325f10
--- /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.