Skip to content

docs: extend datajoint.migrate timeline to 2.4 or 2.5#176

Merged
MilagrosMarin merged 1 commit into
mainfrom
docs/migrate-timeline-bump
May 21, 2026
Merged

docs: extend datajoint.migrate timeline to 2.4 or 2.5#176
MilagrosMarin merged 1 commit into
mainfrom
docs/migrate-timeline-bump

Conversation

@dimitri-yatsenko
Copy link
Copy Markdown
Member

Summary

The "Temporary module" warning at the top of Migrate to DataJoint 2.0 was authored before the timeline slipped. It said the datajoint.migrate module would be deprecated in 2.1 and removed in 2.2, but the module is still present on master at 2.2.x and 2.3 is about to ship with it intact.

Update to the current plan:

Was Now
Removal target 2.2 2.4 or 2.5
Safe migration window while on 2.0 while on 2.3 or earlier
-    The `datajoint.migrate` module is provided temporarily to assist with migration. It will be deprecated in DataJoint 2.1 and removed in 2.2. Complete your migration while on 2.0.
+    The `datajoint.migrate` module is provided temporarily to assist with migration and is scheduled for removal in DataJoint 2.4 or 2.5. We recommend completing your migration while on DataJoint 2.3 or earlier.

A matching docstring update for datajoint-python/src/datajoint/migrate.py (which currently says "deprecated in 2.1 and removed in 2.3. Complete your migrations while on 2.0.") is in a separate PR — keeping the source and docs in lockstep.

Test plan

  • After deploy, confirm the warning admonition at the top of /how-to/migrate-to-v20/ reflects the new timeline
  • No other links or anchors changed

The original warning said migrate would be deprecated in 2.1 and removed
in 2.2, but the module is still present at 2.2.x and 2.3 is shipping
with it intact. Update the timeline to match the current plan:

- Removal target: 2.4 or 2.5 (was: 2.2)
- Safe migration window: 2.3 or earlier (was: 2.0)

A matching docstring update goes to datajoint-python/src/datajoint/
migrate.py in a separate PR.
Copy link
Copy Markdown
Collaborator

@MilagrosMarin MilagrosMarin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dimitri-yatsenko! Verified datajoint.migrate is still present on master at v2.2.2 and the paired upstream PR datajoint-python#1456 will land the docstring + runtime warning update in lockstep. Softer "2.4 or 2.5" framing reads well.

Approving.

@MilagrosMarin MilagrosMarin merged commit 46d80d2 into main May 21, 2026
2 checks passed
@dimitri-yatsenko dimitri-yatsenko deleted the docs/migrate-timeline-bump branch May 21, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants