Milestone 3 Feedback

[Glenn032787]

Congratulations on finishing milestone 3! We can see you put a lot of work into this project, nice work!
Below we list some specific feedback you can use to improve your project.

We provide tick boxes for you to use in the future as you address these concerns to improve the final grade of your project.
If anything is unclear, please feel free to ask questions in this issue thread.

R package

1. Write test cases and code iteratively

rubric={accuracy:20,quality:10,mechanics:10}
Good Job!

Python package checklist

1. GitHub actions workflow for continuous integration

rubric={mechanics:10}
Good Job!

2. GitHub actions workflow for continuous deployment

rubric={mechanics:10}
Good Job!

3. Documentation

rubric={reasoning:10}

• The documentation build with ReadtheDocs is not available (no link on GitHub or in the [README.md](http://readme.md/) file) - -1 reasoning
  Comment: ReadtheDocs link is accessible through the badge in the github readme, but it would be good to include an explicit link in the README

• The documentation lacks of a demostration - -3 reasoning
  Comment Demonstration in the readme does not work. When importing the function, it only works when formating import this way from pybrokk.create_id import create_id rather than just import pybrokk. Would also be good to include sample outputs for demo such as images or first rows of dataframe

Specific expectations for this milestone

rubric={mechanics:10}

Good Job!

Submission instructions

rubric={mechanics:10}
Good Job!

Other comments

Make sure to remove .DS_Store and add it to .gitignore