Browse Source

[1611] pydoc updates: revise overall doc that referred to "FindResult"
(which was C++ version only); corrected the return value description of
find_all() which was accidentally broken.

JINMEI Tatuya 13 years ago
parent
commit
fa538d5bf3
1 changed files with 13 additions and 13 deletions
  1. 13 13
      src/lib/python/isc/datasrc/finder_inc.cc

+ 13 - 13
src/lib/python/isc/datasrc/finder_inc.cc

@@ -47,7 +47,7 @@ Return the RR class of the zone.\n\
 // - NULL->None
 // - NULL->None
 // - exceptions
 // - exceptions
 const char* const ZoneFinder_find_doc = "\
 const char* const ZoneFinder_find_doc = "\
-find(name, type, options=FIND_DEFAULT) -> (integer, RRset, flags)\n\
+find(name, type, options=FIND_DEFAULT) -> (integer, RRset, integer)\n\
 \n\
 \n\
 Search the zone for a given pair of domain name and RR type.\n\
 Search the zone for a given pair of domain name and RR type.\n\
 \n\
 \n\
@@ -70,13 +70,13 @@ answer for the search key. Specifically,\n\
 - If the search name matches a delegation point of DNAME, it returns\n\
 - If the search name matches a delegation point of DNAME, it returns\n\
   the code of DNAME and that DNAME RR.\n\
   the code of DNAME and that DNAME RR.\n\
 \n\
 \n\
-No RRset will be returned in the NXDOMAIN and NXRRSET cases (rrset\n\
+No RRset will be returned in the NXDOMAIN and NXRRSET cases (the\n\
-member of FindResult will be None), unless DNSSEC data are required.\n\
+second element of the tuple will be None), unless DNSSEC data are\n\
-See below for the cases with DNSSEC.\n\
+required. See below for the cases with DNSSEC.\n\
 \n\
 \n\
-The returned FindResult object can also provide supplemental\n\
+The third element of the returned tuple provides supplemental\n\
-information about the search result via its methods returning a\n\
+information about the search result in the form of a bitmask (called\n\
-boolean value. Such information may be useful for the caller if the\n\
+\"flags\"). Such information may be useful for the caller if the\n\
 caller wants to collect additional DNSSEC proofs based on the search\n\
 caller wants to collect additional DNSSEC proofs based on the search\n\
 result.\n\
 result.\n\
 \n\
 \n\
@@ -131,7 +131,7 @@ In case it's signed with NSEC3, there is no further information\n\
 returned from this method.\n\
 returned from this method.\n\
 \n\
 \n\
 In case it's signed with NSEC, this method will possibly return a\n\
 In case it's signed with NSEC, this method will possibly return a\n\
-related NSEC RRset in the rrset member of FindResult. What kind of\n\
+related NSEC RRset in the second element of the tuple. What kind of\n\
 NSEC is returned depends on the result code (NXDOMAIN or NXRRSET) and\n\
 NSEC is returned depends on the result code (NXDOMAIN or NXRRSET) and\n\
 on whether it's a wildcard match:\n\
 on whether it's a wildcard match:\n\
 \n\
 \n\
@@ -186,8 +186,8 @@ Likewise, if zone \"example.org\" has the following record,\n\
 a.example.org. NSEC x.*.b.example.org.\n\
 a.example.org. NSEC x.*.b.example.org.\n\
 \n\
 \n\
 a call to  find() for \"y.b.example.org\" with FIND_DNSSEC will\n\
 a call to  find() for \"y.b.example.org\" with FIND_DNSSEC will\n\
-result in NXRRSET and this NSEC;  isWildcard() on the returned\n\
+result in NXRRSET and this NSEC;  RESULT_WILDCARD bit is set in the\n\
-FindResult object will return true.\n\
+returned flags.\n\
 \n\
 \n\
 This method raises an isc.datasrc.Error exception if there is an\n\
 This method raises an isc.datasrc.Error exception if there is an\n\
 internal error in the datasource.\n\
 internal error in the datasource.\n\
@@ -198,12 +198,12 @@ Parameters:\n\
   options    The search options.\n\
   options    The search options.\n\
 \n\
 \n\
 Return Value(s): A tuple of a result code (integer), an RRset object\n\
 Return Value(s): A tuple of a result code (integer), an RRset object\n\
-and supplemental integer.\n\
+and flags bitmask (integer).\n\
 ";
 ";
 
 
 const char* const ZoneFinder_findAll_doc = "\
 const char* const ZoneFinder_findAll_doc = "\
 find_all(isc.dns.Name, options=FIND_DEFAULT) ->\n\
 find_all(isc.dns.Name, options=FIND_DEFAULT) ->\n\
-   (integer, RRset, flags) | (integer, [RRset], flags)\
+   (integer, RRset, integer) | (integer, [RRset], integer)\
 \n\
 \n\
 Finds all RRsets in the given name.\n\
 Finds all RRsets in the given name.\n\
 \n\
 \n\
@@ -217,7 +217,7 @@ wildcard information etc. The options parameter works the same way and\n\
 it should conform to the same exception restrictions.\n\
 it should conform to the same exception restrictions.\n\
 \n\
 \n\
 Parameters:\n\
 Parameters:\n\
-  target     the successfull result is returned through this\n\
+  name       The domain name to be searched for.\n\
   options    The search options.\n\
   options    The search options.\n\
 \n\
 \n\
 Return Value(s): A tuple of a result code (integer), an either\n\
 Return Value(s): A tuple of a result code (integer), an either\n\