]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
doco conversion
authorBob Halley <halley@dnspython.org>
Tue, 3 Jan 2017 23:12:42 +0000 (15:12 -0800)
committerBob Halley <halley@dnspython.org>
Tue, 3 Jan 2017 23:12:42 +0000 (15:12 -0800)
dns/grange.py

index 9ce9f67a09607dcde28571947929576cf94ecdc1..752858d8d5a75e498bae0321abe7c3f7c60108a2 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2003-2007, 2009-2011 Nominum, Inc.
+# Copyright (C) 2012-2017 Nominum, Inc.
 #
 # Permission to use, copy, modify, and distribute this software and its
 # documentation for any purpose with or without fee is hereby granted,
 
 import dns
 
-
 def from_text(text):
-    """Convert the text form of a range in a GENERATE statement to an
+    """Convert the text form of a range in a ``$GENERATE`` statement to an
     integer.
 
-    @param text: the textual range
-    @type text: string
-    @return: The start, stop and step values.
-    @rtype: tuple
+    *text*, a ``str``, the textual range in ``$GENERATE`` form.
+
+    Returns a tuple of three ``int`` values ``(start, stop, step)``.
     """
-    # TODO, figure out the bounds on start, stop and step.
 
+    # TODO, figure out the bounds on start, stop and step.
     step = 1
     cur = ''
     state = 0