Skip to content

minor docs cleanup #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2015
Merged

minor docs cleanup #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
329dedf
clarify documentation about PTR lookup
dkg Apr 30, 2015
9158cf2
correct docs about address() and general()
dkg Apr 30, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ as its methods and attributes.
DNS record. The keyword arguments are:

* ``name``: a representation of the query term; usually a
string but must be a dict (as described below) in the
string but must be a dict (as described in ``Context.hostname()`` below) in the
case of a PTR record lookup
* ``request_type``: a DNS RR type as a getdns constant
(listed here)
Expand All @@ -190,11 +190,11 @@ as its methods and attributes.

.. py:method:: address(name, [extensions], [userarg], [transaction_id], [callback])

There are three critical differences between
There are two critical differences between
``Context.address()`` and ``Context.general()`` beyond the missing
*request_type* argument:

* In ``getdns.address()``, the name argument can only take a host name.
* In ``Context.address()``, the name argument can only take a host name.
* ``Context.address()`` always uses all of namespaces from the
context (to better emulate getaddrinfo()), while ``Context.general()`` only uses the DNS namespace.

Expand All @@ -205,7 +205,7 @@ as its methods and attributes.

* ``address_type``: must be a string matching either "IPv4"
or "IPv6"
* ``address_type``: a string representation of an IPv4 or
* ``address_data``: a string representation of an IPv4 or
IPv6 IP address

.. py:method:: service(name [, extensions], [userarg], [transaction_id], [callback])
Expand Down