[CLJ-1117] partition docstring should be more explicit about dropped or partial trailing elements Created: 29/Nov/12 Updated: 28/Mar/14
|Affects Version/s:||Release 1.6|
OS X, 10.8
The doc for partition states "In case there are not enough padding elements, return a partition with less than n items." However, the behavior of this function is as follows:
Proposed: The docstring should be updated to make it clear that not providing a pad means that items are dropped, and to also see partition-all.
|Comment by Andy Fingerhut [ 29/Nov/12 2:15 PM ]|
That would be a potentially breaking change for some people's code that uses partition. partition-all behaves as you wish.
Also, your concern with the documentation is for when there are padding elements specified as an argument, but your examples don't specify any padding elements.
|Comment by Timothy Baldridge [ 29/Nov/12 2:55 PM ]|
I agree, but I think the docs should then explicitly state: "if no padding is given, not all input elements may be returned in the output partitions" or something to that line.
|Comment by Andy Fingerhut [ 29/Nov/12 4:43 PM ]|
More precise documentation of current behavior is always welcome in my opinion.
|Comment by Gabriel Horner [ 17/May/13 10:14 AM ]|
I've uploaded a patch that calls out when and how partition drops tail elements: