partition-all docstring should mention it returns vectors in transducer case

Description

partition-all currently states that it returns a collection of lists. Though, when using as a transducer it returns vectors.

Environment

None

Activity

Show:
import
March 6, 2018, 12:00 PM

Comment made by: pbwolf

There is more than a decorative difference between lists and vectors!

This does not seem like a doc bug. The transducer flavor of the function fails to meet a well-stated contract.

In the alternative, that it is just a doc bug and it's OK for partition-all to produce lists sometimes and vectors sometimes, based on a subtle configuration of your program, which you might change for computational reasons, with the nature of the returned structures farthest from your mind, thereby inadvertently up-ending all of your downstream conj's... then the doc bug is essentially that the docs have, all these years, over-stated an internal implementation detail by promising lists, and the safe way to consume the result of partition-all would be with sequence functions only.

Assignee

Unassigned

Reporter

Andre R

Labels

Approval

Triaged

Patch

None

Affects versions

Priority

Minor
Configure