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

Feature/add create db report #868

Closed
wants to merge 17 commits into from

Conversation

sahmad11
Copy link
Contributor

@sahmad11 sahmad11 commented Mar 28, 2022

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

This pull request is to add a new feature create_db_report to DataPrep.eda

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

We have added tests to verify the output and the number of files generated for the tables to match the tables in the database

Snapshots:

Include snapshots for easier review.

Checklist:

  • My code follows the style guidelines of this project
  • I have already squashed the commits and make the commit message conform to the project standard.
  • I have already marked the commit with "BREAKING CHANGE" or "Fixes #" if needed.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

__all__ = ["create_db_report"]


def create_db_report(sql_engine) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Please add the type info for all input parameters. This comment also applies to all other functions.
  2. For the API that users can directly call, the docstring should be in detail, e.g., the what this function does, the meaning of input/output parameters, and an example about how to run it.
  3. Seems the output type should be Report?

@khoatxp khoatxp closed this Mar 29, 2022
@khoatxp khoatxp deleted the feature/add-create-db-report branch March 29, 2022 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants