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

[DOCS] Puts 1.0 example scripts for connecting to dataframe data under test. #10225

Merged
merged 13 commits into from
Aug 20, 2024

Conversation

Rachel-Reverie
Copy link
Contributor

Description

  • Revises "Connect to dataframe data" guidance for 1.0 to match updated workflow.
  • Puts example scripts under test.

Definition of done

  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

Copy link

netlify bot commented Aug 16, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit ec382d3
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/66c3b689af20d2000864e8d2
😎 Deploy Preview https://deploy-preview-10225.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Aug 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.66%. Comparing base (0fd5529) to head (ec382d3).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10225      +/-   ##
===========================================
- Coverage    79.67%   79.66%   -0.01%     
===========================================
  Files          454      454              
  Lines        39507    39507              
===========================================
- Hits         31476    31475       -1     
- Misses        8031     8032       +1     
Flag Coverage Δ
3.10 66.29% <ø> (ø)
3.10 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.10 aws_deps ?
3.10 big ?
3.10 databricks ?
3.10 filesystem ?
3.10 mssql ?
3.10 mysql ?
3.10 postgresql ?
3.10 snowflake ?
3.10 spark ?
3.10 trino ?
3.11 66.29% <ø> (ø)
3.11 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.11 aws_deps ?
3.11 big ?
3.11 databricks ?
3.11 filesystem ?
3.11 mssql ?
3.11 mysql ?
3.11 postgresql ?
3.11 snowflake ?
3.11 spark ?
3.11 trino ?
3.12 64.86% <ø> (ø)
3.12 aws_deps 45.81% <ø> (ø)
3.12 big 54.46% <ø> (ø)
3.12 filesystem 60.45% <ø> (ø)
3.12 mssql 49.91% <ø> (ø)
3.12 mysql 49.97% <ø> (ø)
3.12 postgresql 54.11% <ø> (ø)
3.12 spark 57.58% <ø> (ø)
3.12 trino 52.18% <ø> (ø)
3.8 66.33% <ø> (-0.02%) ⬇️
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 54.67% <ø> (ø)
3.8 aws_deps 45.84% <ø> (ø)
3.8 big 54.48% <ø> (ø)
3.8 databricks 47.10% <ø> (ø)
3.8 filesystem 60.47% <ø> (ø)
3.8 mssql 49.90% <ø> (ø)
3.8 mysql 49.96% <ø> (ø)
3.8 postgresql 54.10% <ø> (ø)
3.8 snowflake 48.02% <ø> (ø)
3.8 spark 57.54% <ø> (ø)
3.8 trino 52.17% <ø> (ø)
3.9 66.33% <ø> (ø)
3.9 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.9 aws_deps ?
3.9 big ?
3.9 databricks ?
3.9 filesystem ?
3.9 mssql ?
3.9 mysql ?
3.9 postgresql ?
3.9 snowflake ?
3.9 spark ?
3.9 trino ?
cloud 0.00% <ø> (ø)
docs-basic 49.84% <ø> (+0.02%) ⬆️
docs-creds-needed 50.57% <ø> (+0.04%) ⬆️
docs-spark 49.53% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


<TabItem value="validate" label="Validation Definition">

A Validation Definition's `validate()` method runs an Expectation Suite against a Batch returned by a Batch Definition. Runtime Batch Parameters can be provided to a Validation Definition's `validate()` method to specify the data returned in the Batch. This allows you to validate your dataframe by executing the Expectation Suite included in the Validation Definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

validate() should be run() in this paragraph.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed! Thank you.

Copy link
Contributor

@tyler-hoffman tyler-hoffman left a comment

Choose a reason for hiding this comment

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

Looks good except the spot that references ValidationDefinition.validate, rather than ValidationDefinition.run in the text.

@Rachel-Reverie Rachel-Reverie added this pull request to the merge queue Aug 20, 2024
Merged via the queue into develop with commit b387f11 Aug 20, 2024
61 checks passed
@Rachel-Reverie Rachel-Reverie deleted the d/doc-803/code_under_test_connect_to_dataframe branch August 20, 2024 12:43
deborahniesz pushed a commit that referenced this pull request Aug 20, 2024
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.

2 participants