Refactor: documentation part 1

[ninaandrup]

Related to #60

In this PR

• [x] Introduction
• [x] Functions
• [x] Data Types
• [x] Lists
• [x] Records
• [x] References
• [x] Arrays
• [x] Namespaces
• [x] Concurrency
• [x] Effects
• [x] Fixpoints
• [x] Interoperability
• [x] Build & Packages
• [x] Tips and Tricks

There are still open issues for some of the pages. But everything not in those issues should be fixed in this PR.

[magnus-madsen]

Good work so far 👍

[ninaandrup]

I'm a bit unsure of this example:

def map(f: a -> b & e, l: List[a]): List[b] & e = ...

The code in the flix library is & ef instead of & e

[magnus-madsen]

We have decided to use ef (instead of e) by convention.

[ninaandrup]

Here Eq is not defines for the enum. Does it matter, since it is illustrating Using Enums from a Namespace ?

[magnus-madsen]

Here Eq is not defines for the enum. Does it matter, since it is illustrating Using Enums from a Namespace ?

You can sneak in a with Eq on the relevant enum.

[ninaandrup]

I think maybe this paragraph needs to be rewritten. I could not find any functions in the library using an argument f: a ~> Unit. Everything is changed to f: a -> Unit & ef, right?

[ninaandrup]

I think maybe this paragraph needs to be rewritten. I could not find any functions in the library using an argument f: a ~> Unit. Everything is changed to f: a -> Unit & ef, right?

Trying it out in VS code, I can see, that f: a ~> Unit won't compile. On the same page, there is already this paragraph about effect polymorphism. Maybe the other paragraph should just inform the user, that specifying an argument function as impure is not possible?

[ninaandrup]

I think maybe this paragraph needs to be rewritten. I could not find any functions in the library using an argument f: a ~> Unit. Everything is changed to f: a -> Unit & ef, right?

Trying it out in VS code, I can see, that f: a ~> Unit won't compile. On the same page, there is already this paragraph about effect polymorphism. Maybe the other paragraph should just inform the user, that specifying an argument function as impure is not possible?

Mentioned again here in the table.

[ninaandrup]

Should I open some new issues for the paragraphs needing to be rewritten and such?

[magnus-madsen]

Should I open some new issues for the paragraphs needing to be rewritten and such?

Yes. Lets keep this PR for simple things and then make a new issue for the things where new sentences are needed.

[magnus-madsen]

Can you open a new ticket for the fixpoint issue? Then I will ask Jonathan to take a look.

[ninaandrup]

Can you open a new ticket for the fixpoint issue? Then I will ask Jonathan to take a look.

Sure :) see #67

[magnus-madsen]

• Very happy to have this!
• Minor comments can be fixed in subsequent PR.