flix / book Goto Github PK

Hi,

I am going through the book examples and got stuck on the second one in next-steps section, where File.readLines() supposed to be Files.readLines() instead (seems like it was renamed on the latest recent release(?)).

Same likely applies to https://github.com/flix/book/blob/9745337eb9809b4d5ae124c44bf5e98925e16b79/src/redundancy.md

E.g., the example from https://doc.flix.dev/creating-objects.html

import new java.io.File(String): ##java.io.File \ IO as newFile;
newFile("HelloWorld.txt")

does not build with 0.41 as is:

-- Parse Error -------------------------------------------------- /Users/wzy/Projects/chess/traps.flix

>> Parse Error: Invalid input 'j', expected ';', Use, Import or Decls (line 3, column 12):
import new java.io.File(String): ##java.io.File \ IO as newFile;
           ^

Syntactic Context: OtherDecl.

Wrapping it in def main(): Unit \ IO = ... works, but it is not super obvious.

Do a quick compare of the book and doc.flix.dev to ensure we have not lost any content.

It would be nice to tie the docs version with the compiler release.

At the time of writing the latest compiler release is v0.41.0, but the online docs already refer to changes that have been merged in master but not released yet, such as Traits.

It took me a while to understand why the compiler was complaining, since I assumed that the examples in the doc would work with the latest available release.

Probably it's not super-priority in this stage of the project since the API is expected to change rapidly, but in the (near?) future consider adding a dropdown menu in the docs to select a target compiler version.

A bit of a nitpick, not really sure if this is a book issue or language issue:

In https://doc.flix.dev/primitive-types.html, the Map Literals section seems to imply map literals are syntactic sugar for inserting from right to left, but Map#{1 => "Hello", 1 => "Lol"} actually evaluates to Map#{1 => Lol}.

Python does the same thing, but I am wondering if we should change Map.insert(1, "Hello", Map.insert(2, "World", Map.empty())) to Map.insert(2, "World", Map.insert(1, "Hello", Map.empty())), which seems to be closer to what's happening in terms of ordering?

Do we need to rebuild highlight.js or something?

I see in some library code out there for (v <- expr) yield expr works, but the book only mentions foreach, forM, and forA. What is for? Is it forM or not quite?

(ticket for much later-- in the summer)

What are some common problems we could describe here?

https://doc.flix.dev/common-problems.html

Once flix/flix#7114 is merged in, we need to scan through the book for examples that use both regions and IO and update them if necessary.

• Error message in effects section is marked as a flix code block. Should not have that language
• String interpolation in fixpoint section contains escape backslash
• Law singletonMeansOne has a param in type class section
• Not all code blocks are marked with flix

Should we have Java syntax highlighted the one place it is used?

Could explain / document how mutability in Flix works. The reference section could be a subsection of this along with examples of mutable data structures (and for loops!).
Thoughts on this?

(ticket for much later-- in the summer)

See flix/flix#6399

E.g.

Proposal:

• The Flix Programming Language
• Introduction

• Getting Started
  • Installation
  • Hello, World!
• Data Types
• Functions
• Lists
• Records
• References
• Arrays
• Namespaces
• Concurrency with Channels and Processes
• Polymorphic Effects
• Fixpoints
• Type Classes
• Interoperability
• Build and Package Management
• The Flix Standard Library
• Everyday Programming
  • Printing to Standard Out
  • String Interpolation
  • Pipelines
  • Anonymous and Named Holes
  • Type Ascriptions

• Advanced Features
  • Type Casts
  • Effect Casts

Hi,
Flix seems awesome, I'm going trough book right now and I think in chapter "Functions" in this code snippet:

there should be `Int32.mod` instead of mod? At least I had to change it that way to run main function.

This page mentions Iterator type with 2 type parameters when it really has 3 now.
https://doc.flix.dev/foreach.html

/*
https://doc.flix.dev/precedence.html states that 'mod' and 'rem' have a certain operator precedence (multiplicative).
I read the website as 'rem' and 'mod' meaning remainder and modulo.
It appears that 'mod' has been changed to mean module while modulo and remainder have been moved to Int32.mod and Int32.rem.
*/