Skip to content

docs: Add "How Validation Works" feature guide#305

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/educate-schema-validation
Closed

docs: Add "How Validation Works" feature guide#305
Copilot wants to merge 2 commits intomainfrom
copilot/educate-schema-validation

Conversation

Copy link
Contributor

Copilot AI commented Mar 26, 2026

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.md covering:

    • Column rules: how constructor arguments (nullable, min, regex, check, …) map to named Polars expressions with the <col>|<rule> naming convention
    • Schema-level @dy.rule() rules (row-level and group-level), including group_by="primary_key"
    • Null-handling semantics (null → valid by default; override with .fill_null(False))
    • The automatic primary_key uniqueness rule
    • The five-step evaluation pipeline: schema matching → rule collection → evaluation (with group-rule join mechanics) → horizontal aggregation → filter/raise
    • The cast parameter and |dtype cast-verification rules
    • All three validation entry-points (validate, filter, is_valid) with examples
    • A rule naming reference table
  • docs/guides/features/index.md — added validation as the first entry in the features toctree


💡 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.

@codecov
Copy link

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (72fb1a6) to head (1156030).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 26, 2026
Copilot AI requested a review from DelongChenQC March 26, 2026 14:08
@borchero Oliver Borchert (borchero) deleted the copilot/educate-schema-validation branch March 26, 2026 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants