[ZDP] BackTalk to Document The Zope Book (2.5 Edition)/Appendix B: API Reference

webmaster@zope.org webmaster@zope.org
Thu, 26 Sep 2002 16:52:42 -0400


A comment to the paragraph below was recently added via http://www.zope.org/Documentation/Books/ZopeBook/current/AppendixB.stx#3-589

---------------

      Creates a new batch given a sequence and a desired batch
          size.

          sequence -- The full sequence.

          size -- The desired batch size.

          start -- The index of the start of the batch (counting from 0).

          end -- The index of the end of the batch (counting from  0).

          orphan -- The desired minimum batch size. This controls how
          sequences are split into batches. If a batch smaller than the
          orphan size would occur, then no split is performed, and a
          batch larger than the batch size results.

          overlap -- The number of elements that overlap between
          batches.

        % Anonymous User - Sep. 26, 2002 4:52 pm:
         Note that the "start" attribute counts from 1, but the "start" parameter of __init__ counts from 0.