]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
add a note on type annotations
authorBob Halley <halley@dnspython.org>
Mon, 31 Aug 2020 15:03:24 +0000 (08:03 -0700)
committerBob Halley <halley@dnspython.org>
Mon, 31 Aug 2020 15:03:24 +0000 (08:03 -0700)
doc/manual.rst
doc/typing.rst [new file with mode: 0644]

index b82b7e1cc37510f86ea2cd67450e7d906f89c8c5..ecf416732b3b25592de228c6921b4cc496af685f 100644 (file)
@@ -15,3 +15,4 @@ Dnspython Manual
    async
    exceptions
    utilities
+   typing
diff --git a/doc/typing.rst b/doc/typing.rst
new file mode 100644 (file)
index 0000000..1325f10
--- /dev/null
@@ -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.