From: haikuo zhang <zhanghaikuo@cnnic.cn>
Date: Fri, 1 Jun 2012 06:45:26 +0000 (+0800)
Subject: [1514] modified the comments. Appended the prerequisite comments for update_soa
X-Git-Tag: trac2351_base~226^2~59^2~10
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4d25eba05071e631333c26580ae495c50c6ae895;p=thirdparty%2Fkea.git

[1514] modified the comments. Appended the prerequisite comments for update_soa
function in DDNS_SOA class
---

diff --git a/src/lib/python/isc/ddns/session.py b/src/lib/python/isc/ddns/session.py
index 1b1032e3bb..c97ddc7375 100644
--- a/src/lib/python/isc/ddns/session.py
+++ b/src/lib/python/isc/ddns/session.py
@@ -148,13 +148,14 @@ class DDNS_SOA:
             return False
 
     def update_soa(self, origin_soa, inc_number = 1):
-        ''' Update the soa number incrementally as RFC 2136.
+        ''' Update the soa number incrementally as RFC 2136. Please make sure
+        that the origin_soa exists and not null before invoke this function.
         Parameters:
             origin_soa, the soa resource record which will be updated.
             inc_number, the number which will be added into the serial number of
             origin_soa, the default value is one.
         Output:
-            the new origin soa whoes serial number has been updated.
+            The new origin soa whoes serial number has been updated.
         '''
         soa_num = self.__get_serial_internal(origin_soa)
         soa_num = soa_num + inc_number