docs: extend datajoint.migrate timeline to 2.4 or 2.5#1456
Merged
Conversation
The module's docstring and runtime DeprecationWarning still pointed at the older "removed in 2.3 / while on 2.0" timeline. The module is still present at 2.2.x and 2.3 is shipping with it intact, so push the targets forward: - Removal target: 2.4 or 2.5 (was: 2.3) - Safe migration window: 2.3 or earlier (was: 2.0) Matches the warning text in the migration how-to in datajoint-docs.
MilagrosMarin
approved these changes
May 21, 2026
Contributor
MilagrosMarin
left a comment
MilagrosMarin
left a comment
There was a problem hiding this comment.
Thanks @dimitri-yatsenko! Verified:
✅ Docstring and warnings.warn(...) updated together to the same timeline (2.4 or 2.5 removal, migrate while on 2.3 or earlier).
✅ Version(__version__) >= Version("2.1") gate preserved — warning still fires on 2.1+.
✅ No code/behavior change, only strings.
✅ Matches the wording in datajoint-docs#176 (which I approved earlier).
Approving.
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
2 participants
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.
Summary
The deprecation timeline in
src/datajoint/migrate.pywas still pointing at a "removed in 2.3 / migrate while on 2.0" plan that has since slipped — the module is present at 2.2.x and 2.3 is shipping with it intact. Update both the module docstring and the runtimeDeprecationWarningtext to match the current plan.Both the docstring
.. note::block and thewarnings.warn(...)message are updated together.Pairs with datajoint-docs#176, which makes the matching change to the
Migrate to DataJoint 2.0how-to.Test plan
python -c "import warnings; warnings.simplefilter('always'); import datajoint.migrate"shows the new warning textNote on mypy
Local pre-commit's mypy hook fails on a pre-existing unrelated error in
storage_adapter.py:98(a typing shim for olderimportlib.metadata). Not enforced by CI (lint.yamlonly runs codespell + ruff + ruff-format). Skipped withSKIP=mypy git commitper the documented pattern at the top of.pre-commit-config.yaml. Same workaround used in #1455.