docs(examples): add simple example #30
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Example
This PR introduces the first example to the examples/ folder of the SparkDQ repository.
The goal is to demonstrate a minimal, working use case that helps users understand how to apply SparkDQ in a practical scenario.
📂 What's Included
A simple example showcasing:
How to define and run a basic data quality check
How to access pass_df() and fail_df() results
Clear structure and comments to make the example easy to follow
Updated examples/README.md to explain the purpose of the directory and invite the community to suggest further examples via issues
🧭 Motivation
Providing ready-to-run examples helps new users get started faster and makes it easier to understand how SparkDQ can be used in real-world pipelines.
This basic example lays the groundwork for a growing collection of scenarios.