Documentation of standard library collection functions

[ryepesg]

Documenting the standard library collection functions to help users understand differences between collections and help to identify inconsistencies.

From issue "Documentation of gotchas in the standard library:

Maybe we ought to make a big matrix of the functions in the stdlib over the various data types and then identify inconsistencies.

[JonathanStarup]

I think traits are useful when classifying collections. Which traits generalize these things, and which data types implement them.

Here is a discussion about my confusion about Iterable vs Foldable for example flix/flix#9335

[magnus-madsen]

Hi @ryepesg and thanks for your contribution.

I can see you put a lot of effort into it 👍

We usually try to coordinate work either through tickets or on Gitter before actually starting the work.

Here, in this case, it seems the text is partially documentation but also partially a list of things that need to be looked into (e.g. missing functions). We try not to use the Flix book as a roadmap, but only to document things that work. So that is something to think about.

I would invite you to come by Gitter to chat more: https://app.gitter.im/#/room/#flix_Lobby:gitter.im

[ryepesg]

@JonathanStarup great insight, I do think having a page comparing which traits are implemented for each collection would be very useful.
@magnus-madsen thanks for the guidance, will follow up in Gitter.