lidavidm / reduct-redux

A game to teach functional programming concepts
https://games.lidavidm.me/reduct-redux/docs
Mozilla Public License 2.0
1 stars 0 forks source link

Documentation needs more fleshing out #278

Open andrewcmyers opened 6 years ago

andrewcmyers commented 6 years ago

The existing documentation is helpful, but having done some hacking on the system, I can see that there are many things that ought to be described in more detail, such as the relationship between expression nodes and projections and how that is maintained, the different kinds of projections and expressions, the difference between fields and subexpressions, and so on. After hours playing with the code, I understand some of this stuff -- somewhat.

This kind of stuff could alternatively be explained in the code, which is rather sparsely documented; that might help avoid documentation rot.

andrewcmyers commented 6 years ago

The documentation under "Modules" is more detailed than I realized, but is a little hard to get to. So perhaps some reorg would also help.