Add deprecation note about the Resolver nameserver attribute.

diff --git a/doc/resolver-class.rst b/doc/resolver-class.rst
index c491492a6bd8236c5850ab041fea15bd0579d407..5bf01e379b448830d3087070108fa829c25eddad 100644 (file)
--- a/doc/resolver-class.rst
+++ b/doc/resolver-class.rst
@@ -14,6 +14,10 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
 
       A ``list`` of ``str``, each item containing an IPv4 or IPv6 address.
 
+      This field is planned to become a property in dnspython 2.4.  Writing to this
+      field other than by direct assignment is deprecated, and so is depending on the
+      mutability and form of the iterable returned when it is read.
+
    .. attribute:: search
 
       A ``list`` of dns.name.Name objects.  If the query name is a
@@ -55,7 +59,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
       An object implementing the caching protocol, e.g. a
       ``dns.resolver.Cache`` or a ``dns.resolver.LRUCache``.  The default
       is ``None``, in which case there is no local caching.
-       
+
    .. attribute:: retry_servfail
 
       A ``bool``.  Should we retry a nameserver if it says ``SERVFAIL``?
@@ -75,7 +79,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
       A ``dns.name.Name`` or ``None``, the name of the TSIG key to
       use; defaults to ``None``. The key must be defined in the
       keyring.
-        
+
    .. attribute:: keyalgorithm
 
       A ``dns.name.Name`` or ``str``, the TSIG algorithm to use.

diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst
index 470cb510a97cc26d9fd4b14f1ddf6bff08dcf5cc..af695538f94866332eafa2865afcf23c14b93cd7 100644 (file)
--- a/doc/whatsnew.rst
+++ b/doc/whatsnew.rst
@@ -3,11 +3,6 @@
 What's New in dnspython
 =======================
 
-2.3.0 (in development)
-----------------------
-
-* TBD
-
 2.3.0
 -----
 
@@ -41,6 +36,11 @@ What's New in dnspython
 * Curio asynchronous I/O support is deprecated as of this release and will
   be removed in a future release.
 
+* The resolver object's ``nameserver`` field is planned to become a property in
+  dnspython 2.4.  Writing to this field other than by direct assignment is deprecated,
+  and so is depending on the mutability and form of the iterable returned when it is
+  read.
+
 2.2.1
 -----