From: Bob Halley Date: Tue, 3 Jan 2017 23:12:42 +0000 (-0800) Subject: doco conversion X-Git-Tag: v1.16.0~90 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8db7de470891dc78050f16a8f41b2582ae563e3b;p=thirdparty%2Fdnspython.git doco conversion --- diff --git a/dns/grange.py b/dns/grange.py index 9ce9f67a..752858d8 100644 --- a/dns/grange.py +++ b/dns/grange.py @@ -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, @@ -17,18 +17,16 @@ 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