Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Aug 7, 2023

Conversation

mbelak-dtml
Copy link
Collaborator

@mbelak-dtml mbelak-dtml commented Aug 1, 2023

Resolves #45

@mbelak-dtml mbelak-dtml self-assigned this Aug 1, 2023
@mbelak-dtml mbelak-dtml changed the title Refactor/default report refactor!: Refactor Report into Report and DefaultReport. Aug 1, 2023
@mbelak-dtml mbelak-dtml force-pushed the refactor/default-report branch 2 times, most recently from 8faa91e to 09d84f6 Compare August 1, 2023 12:09
BREAKING CHANGE:
* Most parameters of `Report` class have been removed. `Report` class now behaves as it would previously with `use_default_sections=False`.
* Newly-added class `DefaultReport` now behaves as `Report` previously would with `use_default_sections=True`.
* Most parameters of `TimeseriesReport` class have been removed. `DefaultTimeseriesReport` class now behaves as it would previously with `use_default_sections=False`.
* Newly-added class `DefaultTimeseriesReport` now behaves as `TimeseriesReport` previously would with `use_default_sections=True`.
@mbelak-dtml mbelak-dtml changed the title refactor!: Refactor Report into Report and DefaultReport. refactor!: Refactor Report into Report and DefaultReport. Aug 1, 2023
@mbelak-dtml mbelak-dtml requested a review from lukany August 1, 2023 12:18
@mbelak-dtml mbelak-dtml marked this pull request as ready for review August 1, 2023 12:18
Copy link
Contributor

@lukany lukany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. There is still mention about use_default_sections argument in docs:
    report = edvart.Report(df, use_default_sections=False)
  2. 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.

@mbelak-dtml mbelak-dtml changed the title refactor!: Refactor Report into Report and DefaultReport. feat!: Refactor Report into Report and DefaultReport. Aug 4, 2023
@mbelak-dtml
Copy link
Collaborator Author

  1. There is still mention about use_default_sections argument in docs:
    report = edvart.Report(df, use_default_sections=False)

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.

@mbelak-dtml mbelak-dtml requested a review from lukany August 4, 2023 14:00
@lukany lukany added this pull request to the merge queue Aug 7, 2023
Merged via the queue into datamole-ai:main with commit d664e6c Aug 7, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Create DefaultReport
2 participants