These are three suggestions for the docs, which were in my review.
1) Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.) The repo contains a benchmark folder with a benchmark file that compares the proposed approach with other "julian" approaches to obtain the same functionality. Maybe the author could mention the results of these benchmarks in the README.md file to justify the finite-state machine approach.
2) A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is? Yes. This is clearly spelled out in the main page. However, the author might wish to include the benchmarks in the documentation (or mention them), to show how this package solves the original problem (i.e. the slow performance of the Task-based approach).
3) Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems). Given the scope of this package, the examples provided in the repo are sufficient to demonstrate the functionality of this software. If the author is using this functionality in other public domain Julia packages (like he seems to be), these could be mentioned in the docs, so that users can then look at more involved examples.
I think these would be useful additions to the docs.
Hi,
These are three suggestions for the docs, which were in my review.
1) Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.) The repo contains a benchmark folder with a benchmark file that compares the proposed approach with other "julian" approaches to obtain the same functionality. Maybe the author could mention the results of these benchmarks in the README.md file to justify the finite-state machine approach.
2) A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is? Yes. This is clearly spelled out in the main page. However, the author might wish to include the benchmarks in the documentation (or mention them), to show how this package solves the original problem (i.e. the slow performance of the
Task-based approach).3) Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems). Given the scope of this package, the examples provided in the repo are sufficient to demonstrate the functionality of this software. If the author is using this functionality in other public domain Julia packages (like he seems to be), these could be mentioned in the docs, so that users can then look at more involved examples.
I think these would be useful additions to the docs.