Skip to content

Commit 374ba52

Browse files
committed
Updated documentation to match current code
1 parent 41edc98 commit 374ba52

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/functions.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ as its methods and attributes.
6666
element 0, second as list element 1, and so on). The
6767
possible values are ``getdns.TRANSPORT_UDP``,
6868
``getdns.TRANSPORT_TCP``, ``getdns.TRANSPORT_TLS``,
69-
and ``getdns.TRANSPORT_STARTTLS``.
69+
and ``getdns.TRANSPORT_STARTTLS``. [n.b.: *the
70+
``dns_transport`` attribute is still supported but will
71+
be deprecated in a future release*]
7072

7173
.. py:attribute:: limit_outstanding_queries
7274

@@ -442,7 +444,7 @@ differences:
442444
address lookup could look like
443445

444446
>>> c = getdns.Context()
445-
>>> tid = c.address('www.example.org', callback='my_callback')
447+
>>> tid = c.address('www.example.org', callback=my_callback)
446448

447449
* We've introduced a new ``Context`` method, called
448450
``run``. When your program is ready to check to see
@@ -454,6 +456,11 @@ differences:
454456
context, ``run`` will invoke all of those that are
455457
waiting and ready.
456458

459+
* In previous releases the callback argument took the
460+
form of a literal string, but as of this release you
461+
may pass in the name of any Python runnable, without
462+
quotes. The newer form is preferred.
463+
457464
The callback script takes four arguments: ``type``,
458465
``result``, ``userarg``, and ``transaction_id. The ``type``
459466
argument contains the callback type, which may have one of

0 commit comments

Comments
 (0)