Commit 019fff0e authored by Amos Latteier's avatar Amos Latteier

Fixed the dtml-in documentation to record that orphan, not overlap has a...

Fixed the dtml-in documentation to record that orphan, not overlap has a default of 3. Also clarified what exactly the orphan option does. We might consider changing the ophan option default to 0, since I think that folks would find that less confusing.
parent 80476f7f
......@@ -39,10 +39,20 @@ in: Loops over sequences
skip_unauthorized -- Don't raise an exception if an unauthorized
item is encountered.
orphan=int -- The desired minimum batch size.
orphan=int -- 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.
For example, if the sequence size is 12, the batch size is 10
the orphan size is 3, then the result is one batch with all 12
items since splitting the items into two batches would result in
a batch smaller than the orphan size.
The default value is 3.
overlap=int -- The number of items to overlap between batches. The
default value is 3.
default is no overlap.
previous -- Iterates once if there is a previous batch. Sets batch
variables for previous sequence.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment