UBC-MDS / datexplore

python package for EDA and data cleaning
MIT License
1 stars 0 forks source link

List of changes completed - addressing feedback #88

Open jcairn02 opened 8 months ago

jcairn02 commented 8 months ago

https://github.com/UBC-MDS/datexplore/issues/77 The above issue# 77 contains the list of potential changes we were suggested to address.

Current Issue#88 is listing the changes we made addressing the feedback above. I will add this to the final submission document for TA's to view.

  1. Expand introduction: More details added https://github.com/UBC-MDS/datexplore/pull/80

  2. Installation Instructions: Update and improve installation instructions https://github.com/UBC-MDS/datexplore/pull/105

  3. Test File Organization: Removed redundant test files https://github.com/UBC-MDS/datexplore/pull/84

  4. Removed unnecessary environment.yml, poetry handles our environment.yml https://github.com/UBC-MDS/datexplore/pull/78

  5. Added code and bold formatting to improve presentation of the example documentation https://github.com/UBC-MDS/datexplore/pull/90

  6. Additional Badges: Included badges for CI/CD and test coverage in the README. Improved visuals. https://github.com/UBC-MDS/datexplore/pull/80
    https://github.com/UBC-MDS/datexplore/pull/82

  7. Added expected output to clean_names and detect_outliers function examples (TA feedback Milestone 1) https://github.com/UBC-MDS/datexplore/pull/91

jcairn02 commented 8 months ago

I will edit this file as more steps are completed

killerninja8 commented 8 months ago

Thanks for putting it all together. Looks great!