docs: Add "How Validation Works" feature guide#305
Closed
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #305 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 56 56
Lines 3218 3218
=========================================
Hits 3218 3218 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: DelongChenQC <145012678+DelongChenQC@users.noreply.github.com> Agent-Logs-Url: https://github.com/Quantco/dataframely/sessions/e27a5fa9-f7a5-4dd3-b499-cee539b949aa
Copilot
AI
changed the title
[WIP] Add documentation on schema validation in dataframely
docs: Add "How Validation Works" feature guide
Mar 26, 2026
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
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.
There was no dedicated guide explaining dataframely's validation internals — how column constraints become named rules, how
@dy.rule()and group rules are assembled, and what the evaluation pipeline actually does step-by-step.Changes
New guide
docs/guides/features/validation.mdcovering:nullable,min,regex,check, …) map to named Polars expressions with the<col>|<rule>naming convention@dy.rule()rules (row-level and group-level), includinggroup_by="primary_key"null→ valid by default; override with.fill_null(False))primary_keyuniqueness rulecastparameter and|dtypecast-verification rulesvalidate,filter,is_valid) with examplesdocs/guides/features/index.md— addedvalidationas the first entry in the featurestoctree💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.