More and better documentation - Githubissues

TomasMikula / libretto

Declarative concurrency and stream processing library for Scala

Mozilla Public License 2.0

196 stars 7 forks source link

More and better documentation #85

Open MateuszKowalewski opened 1 year ago

MateuszKowalewski commented 1 year ago

For someone looking into this from the outside much more documentation is needed.

[ ] Add much more doc comments. That's kind of baseline.
[ ] Add more comments explaining how the usage side of the code (test projects) are intended to work.
[ ] Describe the overall code structure. How is the DSL structured? How is it implemented?
[ ] Add some reference. (Could be maybe extracted form doc comments on the DSL)

I'll extend this issue in case I would have more requests for documentation… :smile: