docs: Add v3 migration guide - #388
Merged
Merged
Conversation
Oliver Borchert (borchero)
requested review from
Andreas Albert (AndreasAlbertQC) and
Daniel Elsner (delsner)
as code owners
July 30, 2026 23:17
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## lazy-in-lazy-out #388 +/- ##
==================================================
Coverage 100.00% 100.00%
==================================================
Files 46 46
Lines 2590 2590
==================================================
Hits 2590 2590 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new v2→v3 migration guide to document the intended v3 API changes and links it from the migration guide index, aiming to finalize documentation around the v3 transition.
Changes:
- Added
docs/guides/migration/v2-v3.mdmigration guide covering (intended) v3 improvements and breaking changes. - Updated the migration guide
toctreeto include the new v2→v3 guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/guides/migration/v2-v3.md | New migration guide describing v2→v3 changes and recommended code updates. |
| docs/guides/migration/index.md | Adds v2-v3 to the migration guide navigation. |
Comments suppressed due to low confidence (2)
docs/guides/migration/v2-v3.md:20
- The statement that dataframely no longer relies on
pyarrowas an optional dependency appears incorrect: the library still conditionally importspyarrow(viadataframely._compat.pa) and exposesSchema.to_pyarrow_schema()/Column.pyarrow_dtypecode paths that requirepyarrow. Consider rephrasing to avoid implyingpyarrowsupport is removed.
As a result, dataframely does not rely on `pyarrow` as an optional dependency anymore.
docs/guides/migration/v2-v3.md:26
- This section describes a
categoriesargument and referencespl.Categories, butdataframely.Categoricaldoes not accept acategoriesparameter and there is nopl.Categoriesusage in the codebase. The exampledy.Categorical(pl.UInt16)/dy.Categorical(pl.Categories(...))will not work. Consider documentingdy.Enum(which does accept categories and maps topl.Enum) instead, or update the text to match the actual v3 categorical API.
### Refined `dy.Categorical`
{class}`~dataframely.Categorical` now accepts a `categories` argument, allowing to pass a `pl.Categories` object.
Alternatively, a data type may be passed, which automatically infers `name` and `namespace` of the `pl.Categories`
object as the column and schema names, respectively, scoping the categorical to the specific column of a single schema.
Andreas Albert (AndreasAlbertQC)
approved these changes
Jul 31, 2026
Andreas Albert (AndreasAlbertQC)
left a comment
Collaborator
There was a problem hiding this comment.
Ah, here's the guide already, nice, thanks!
Oliver Borchert (borchero)
changed the base branch from
main
to
lazy-in-lazy-out
July 31, 2026 11:19
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
This should finalize the changes for v3.