datamole-ai / edvart

An open-source Python library for Data Scientists & Data Analysts designed to simplify the exploratory data analysis process. Using Edvart, you can explore data sets and generate reports with minimal coding.
https://datamole-ai.github.io/edvart/
MIT License
48 stars 7 forks source link

feat!: Refactor `Report` into `Report` and `DefaultReport`. #47

Closed mbelak-dtml closed 1 year ago

mbelak-dtml commented 1 year ago

Resolves #45

mbelak-dtml commented 1 year ago
  1. There is still mention about use_default_sections argument in docs: https://github.com/datamole-ai/edvart/blob/9d3dda11f270004914187d93a264477cc4569ca7/docs/advanced.rst?plain=1#L129

Thanks, fixed.

  1. The PR should be IMO feat!, not refactor!. Theoratically, it doesn't add any new features but it technically it changes API of existing classes and adds new classes.

I'm not sure what constitutes a refactor! then. My understanding is that it is a change, which does not add or remove a feature, but includes a breaking change in the public API. The first commit does not add or remove a feature from the point of view of the whole package (the set of features is still the same), but it does add and remove on the class level. I changed it to feat! anyway since there is also a feat commit in the PR though.