From 2495908454c1c5e2bdb663c5bbcfb12d428b4e0d Mon Sep 17 00:00:00 2001 From: Bob Halley Date: Tue, 20 Sep 2016 12:16:09 -0700 Subject: [PATCH] fix minor doco errors. --- dns/exception.py | 4 ++-- dns/resolver.py | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/dns/exception.py b/dns/exception.py index 151f5844..6c0b1f4b 100644 --- a/dns/exception.py +++ b/dns/exception.py @@ -23,14 +23,14 @@ class DNSException(Exception): It supports two basic modes of operation: a) Old/compatible mode is used if __init__ was called with - empty **kwargs. + empty **kwargs. In compatible mode all *args are passed to standard Python Exception class as before and all *args are printed by standard __str__ implementation. Class variable msg (or doc string if msg is None) is returned from str() if *args is empty. b) New/parametrized mode is used if __init__ was called with - non-empty **kwargs. + non-empty **kwargs. In the new mode *args has to be empty and all kwargs has to exactly match set in class variable self.supp_kwargs. All kwargs are stored inside self.kwargs and used in new __str__ implementation to construct diff --git a/dns/resolver.py b/dns/resolver.py index d1a38041..d20f80bc 100644 --- a/dns/resolver.py +++ b/dns/resolver.py @@ -135,8 +135,9 @@ class NoNameservers(dns.exception.DNSException): """All nameservers failed to answer the query. - @param errors: list of servers and respective errors - @type errors: [(server ip address, any object convertible to string)] + errors: list of servers and respective errors + The type of errors is + [(server ip address, any object convertible to string)]. Non-empty errors list will add explanatory message () """ @@ -431,7 +432,7 @@ class LRUCache(object): """Initialize a DNS cache. @param max_size: The maximum number of nodes to cache; the default is - 100000. Must be > 1. + 100,000. Must be greater than 1. @type max_size: int """ self.data = {} -- 2.47.3