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

[ENHANCEMENT] Pre-hackathon improvement in the contrib dev loop process and documentation #2296

Merged
merged 21 commits into from Jan 22, 2021

Conversation

eugmandel
Copy link
Contributor

@eugmandel eugmandel commented Jan 21, 2021

Changes proposed in this pull request:

  • Expectation.run_diagnostics:
    • "Hardening" of the logic: Original implementation did not catch any Exceptions and could not produce a report when it did. The change: if errors are encountered in the process of running the diagnostics, they are assumed to be due to incompleteness of the Expectation's implementation (e.g., declaring a dependency on Metrics that do not exist). These errors are added under "diagnostics_report" key in the report.
    • while only examples with include_in_gallery = True are included in the report's "example" section, all tests are executed for the "test_report" section.
  • "How to contribute a new Expectation to Great Expectations: how-to guide:
    • Multiple readability improvements based on the feedback from Alex, Anthony and Gil.
  • Include include_in_gallery attribute in the examples in the Expectation templates and document this attribute in the how-to guide

Previous Design Review notes:

  • N/A

eugmandel and others added 13 commits January 21, 2021 12:31
…ithub.com:great-expectations/great_expectations into eugene/expectations_contrib_improvements_20210121
…ithub.com:great-expectations/great_expectations into eugene/expectations_contrib_improvements_20210121
…encountered in the process of running the diagnostics, they are assumed to be due to

        incompleteness of the Expectation's implementation (e.g., declaring a dependency on Metrics
        that do not exist). These errors are added under "errors" key in the report.
…ery = True are included in the report's "example" section, all tests are executed for the "test_report" section.
…ithub.com:great-expectations/great_expectations into eugene/expectations_contrib_improvements_20210121
…on templates and document this attribute in the how-to guide
@eugmandel eugmandel changed the title [ENHANCEMENT] WIP: Pre-hackathon improvement in the contrib dev loop process and documentation [ENHANCEMENT] Pre-hackathon improvement in the contrib dev loop process and documentation Jan 22, 2021
@eugmandel eugmandel merged commit d9aa060 into develop Jan 22, 2021
@eugmandel eugmandel deleted the eugene/expectations_contrib_improvements_20210121 branch January 22, 2021 22:52
robertparker pushed a commit to robertparker/great_expectations that referenced this pull request Feb 4, 2021
…ss and documentation (great-expectations#2296)

Expectation.run_diagnostics:
* "Hardening" of the logic: Original implementation did not catch any Exceptions and could not produce a report when it did. The change: if errors are encountered in the process of running the diagnostics, they are assumed to be due to incompleteness of the Expectation's implementation (e.g., declaring a dependency on Metrics that do not exist). These errors are added under "diagnostics_report" key in the report.
while only examples with include_in_gallery = True are included in the report's "example" section, all tests are executed for the "test_report" section.
* "How to contribute a new Expectation to Great Expectations: how-to guide:
Multiple readability improvements based on the feedback from Alex, Anthony and Gil.
* Include include_in_gallery attribute in the examples in the Expectation templates and document this attribute in the how-to guide
alexsherstinsky pushed a commit to alexsherstinsky/great_expectations that referenced this pull request Feb 19, 2021
…ss and documentation (great-expectations#2296)

Expectation.run_diagnostics:
* "Hardening" of the logic: Original implementation did not catch any Exceptions and could not produce a report when it did. The change: if errors are encountered in the process of running the diagnostics, they are assumed to be due to incompleteness of the Expectation's implementation (e.g., declaring a dependency on Metrics that do not exist). These errors are added under "diagnostics_report" key in the report.
while only examples with include_in_gallery = True are included in the report's "example" section, all tests are executed for the "test_report" section.
* "How to contribute a new Expectation to Great Expectations: how-to guide:
Multiple readability improvements based on the feedback from Alex, Anthony and Gil.
* Include include_in_gallery attribute in the examples in the Expectation templates and document this attribute in the how-to guide
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

2 participants