Documentation of order of elements in Iterable.kt

[peter-cunderlik-kmed]

Question rather than an issue: the docs in Iterable.kt for e.g. getAll() mention that the order is preserved. Other methods like combine() don't mention anything about the order.

Is the order guaranteed and it's just that the docs are a bit inconsistent between methods or the order for some methods is not guaranteed?

[michaelbull]

Thanks for the question - looking at the implementation the Ok results will appear in the List in order of iteration (so whatever order the Iterable.map would return). I think it's safe to assume that they are guaranteed to be in order.

I'd accept a PR to improve the documentation here - it's basically just the same documentation as the implementation in Elm which doesn't specify anything about order, so we could improve it here.

[peter-cunderlik-kmed]

Thank you! The PR is ready.