Overall it is a great package! The scope of the project is large that I am impressed by the amount of work that has been done.
Great documentation on readthedocs!
I thought the write up in the readme was a really nice little introduction to the project, so well done in that respect!
Your tests are incredibly thorough š
Overall I like your project very much and I am impressed of the work and efforts that you have done. I also found your idea of this project very interesting and beneficial, so great work!
The test and the documentations (both readme and the example) are extremely complete.
It seems the tests are failing, looking at the ci/cd report at the latest commit.
For the text_reading when users submitted a wrong format of file, from a user point of view, I would like the error message to indicate which function I can use instead.
Documentation
contributor: lack of a list of contributors in readme file.
python ecosystem: it would be better if it had a header, easy to locate.
badge: it's better to create several related badges at the top of the readme (e.g., python version)
This is a minor nitpick but I would suggest having your other headers like "Introduction", "Getting Started with ..." to be second level headers (##) instead of first level headers (#). This is because the first level header is for the tutorial title. This will display better on the sidebar.
Link to your read the docs page would be nice to include in the readme
Doesn't really matter but the format of the docstrings vary from file to file
Readme file: only the text_reading doesn't have a short description of what each function is doing, a bit of inconsistency.
Installation
installation: the required python package is 3.11.6. It would be better if there is an environment file or guidelines on successfully installing the package.
Currently the installation instructions are not working
I would also suggest adding a section on how to install the package as "dev", using the conda environment and poetry. This is useful for people who want to contribute to the package.
Change Log (to be linked in PDF for submission)
Fix for adding GitHub Actions: @Sampsonyu did the ci-cd and ci yml files -> thank you!
Whole group is working on editing and debugging these files
Fix for failing tests: Whole group fixing bug fix for the faliling pytest (with the word cloud function)
Fix for installation instructions: @wenyunie edited installation instructions - we did not originally see the message on Slack with regard to the developer instructions. However, this might not be reflected in Milestone 4 since we will be using pip install by then
Fix for read function error message: @gtmx23 will fix this
Fix for README:
Fix for adding names: @Prabh95
Add short description of what each function is doing - text reading: @gtmx23
Peer Review Overview
Positive Feedback
Areas for Improvement Function/Tests
Documentation
Installation
Change Log (to be linked in PDF for submission)
pip installby thenNext Steps