Repository navigation
docs: Update documentation and skill - #424
Draft
Moritz Potthoff (MoritzPotthoffQC) wants to merge 7 commits into
Draft
Moritz Potthoff (MoritzPotthoffQC) wants to merge 7 commits into
Moritz Potthoff (MoritzPotthoffQC) wants to merge 7 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #424 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 46 46
Lines 2587 2587
=========================================
Hits 2587 2587 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The quickstart example fails with a NameError because Polars is not imported before use, and the skill guidance incorrectly suggests that Collection.is_valid supports lazy=True.
2 open issues
What changed in this PR
This documentation-only PR updates Dataframely’s usage skill and guides to reflect the current public API.
Changes:
- Clarifies lazy validation, uniqueness constraints, column descriptions, and collection sampling.
- Corrects examples, error output, and documentation links.
- Expands API reference coverage for existing public methods and classes.
| File | Description |
|---|---|
| skills/SKILL.md | Updates validation, collection, and sampling guidance. |
| docs/guides/quickstart.md | Adds a grouped rule example and updates API usage. |
| docs/guides/migration/v1-v2.md | Replaces scan-method cross-references with inline code. |
| docs/guides/features/sql-generation.md | Clarifies SQL constraints and corrects table creation. |
| docs/guides/features/primary-keys.md | Documents independent column uniqueness. |
| docs/guides/features/lazy-validation.md | Explains current schema and collection lazy behavior. |
| docs/guides/features/data-generation.md | Corrects sampling guidance and collection examples. |
| docs/guides/features/column-metadata.md | Documents the column description parameter. |
| docs/guides/faq.md | Updates uniqueness guidance and fixes a section link. |
| docs/guides/examples/real-world.ipynb | Refreshes recorded outputs and validation errors. |
| docs/conf.py | Removes the obsolete group-rules warning exception. |
| docs/api/schema/conversion.rst | Adds Schema.to_pydantic_model to the reference. |
| docs/api/misc/index.rst | Adds CollectionMember to the reference. |
| docs/api/filter_result/failure_info.rst | Adds FailureInfo.details to the reference. |
| docs/api/columns/index.rst | Adds the base Column class to the reference. |
| docs/api/collection/metadata.rst | Adds eager and lazy member inspection methods. |
Review effort: Balanced
This branch has not been deployed
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.


Motivation
Some portions of the docs and skill are outdated.
Changes