You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify 2.0 as baseline for version admonitions
Updated versioning documentation to reflect that:
- DataJoint 2.0 is the baseline for this documentation
- Version admonitions (version-added, version-changed, version-deprecated)
will only be used for features introduced in 2.1 and later
- Features present in 2.0 are documented without version markers
- Pre-2.0 migration info belongs in the Migration Guide, not admonitions
Examples updated:
- Changed "New in 2.0" → "New in 2.1"
- Changed "Changed in 2.0" → "Changed in 2.1"
- Changed "Deprecated in 2.0" → "Deprecated in 2.1"
- Added note that 2.0 baseline features are not marked
- Added note that pre-2.0 deprecations are in Migration Guide
This keeps the documentation clean and focused on the current baseline
while providing infrastructure for future version markers.
Copy file name to clipboardExpand all lines: src/about/versioning.md
+27-20Lines changed: 27 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ This page explains how version information is indicated throughout the DataJoint
6
6
7
7
**This documentation covers DataJoint 2.0 and later.** All code examples and tutorials use DataJoint 2.0+ syntax and APIs.
8
8
9
+
**DataJoint 2.0 is the baseline.** Features and APIs introduced in 2.0 are documented without version markers, as they are the standard for this documentation.
10
+
9
11
If you're using legacy DataJoint (version 0.14.x or earlier), please visit the [legacy documentation](https://datajoint.github.io/datajoint-python) or follow the [Migration Guide](../how-to/migrate-to-v20.md) to upgrade.
10
12
11
13
## Version Indicators
@@ -18,53 +20,58 @@ If you're using legacy DataJoint (version 0.14.x or earlier), please visit the [
18
20
19
21
### Feature-Level Indicators
20
22
21
-
For specific features, you'll see version admonitions:
23
+
Version admonitions are used for features introduced **after 2.0** (i.e., version 2.1 and later):
22
24
23
25
#### New Features
24
26
25
-
!!! version-added "New in 2.0"
27
+
!!! version-added "New in 2.1"
28
+
29
+
This indicates a feature that was introduced after the 2.0 baseline.
26
30
27
-
This indicates a feature that was introduced in DataJoint 2.0.
31
+
**Example usage:**
28
32
29
-
**Example from documentation:**
33
+
!!! version-added "New in 2.1"
30
34
31
-
!!! version-added "New in 2.0"
35
+
The `dj.Top` operator with ordering support was introduced in DataJoint 2.1.
32
36
33
-
Semantic matching validates joins based on lineage tracking. This feature was introduced in DataJoint 2.0.
37
+
**Note:** Features present in DataJoint 2.0 (the baseline) are not marked with version indicators.
34
38
35
39
#### Changed Behavior
36
40
37
-
!!! version-changed "Changed in 2.0"
41
+
!!! version-changed "Changed in 2.1"
38
42
39
-
This indicates behavior that changed from previous versions.
43
+
This indicates behavior that changed in a post-2.0 release.
40
44
41
-
**Example from documentation:**
45
+
**Example usage:**
42
46
43
-
!!! version-changed "Changed in 2.0"
47
+
!!! version-changed "Changed in 2.1"
44
48
45
-
The fetch API was redesigned in 2.0. Use `to_dicts()` or `to_arrays()` instead of `fetch()`.
49
+
The `populate()` method now supports priority-based scheduling by default.
46
50
47
-
**Legacy (pre-2.0):** `data = table.fetch()`
48
-
**Current (2.0+):** `data = table.to_dicts()`
51
+
Use `priority=50` to control execution order when using `reserve_jobs=True`.
49
52
50
53
#### Deprecated Features
51
54
52
-
!!! version-deprecated "Deprecated in 2.0, removed in 3.0"
55
+
!!! version-deprecated "Deprecated in 2.1, removed in 3.0"
53
56
54
57
This indicates features that are deprecated and will be removed in future versions.
55
58
56
-
**Example from documentation:**
59
+
**Example usage:**
57
60
58
-
!!! version-deprecated "Deprecated in 2.0, removed in 3.0"
61
+
!!! version-deprecated "Deprecated in 2.1, removed in 3.0"
59
62
60
-
The `external` storage type is deprecated. Use unified stores with `<blob@store>` syntax instead.
63
+
The `allow_direct_insert` parameter is deprecated. Use `dj.config['safemode']` instead.
64
+
65
+
**Note:** Features deprecated at the 2.0 baseline (coming from pre-2.0) are documented in the [Migration Guide](../how-to/migrate-to-v20.md) rather than with admonitions, since this documentation assumes 2.0 as the baseline.
61
66
62
67
### Inline Version Badges
63
68
64
-
In API reference documentation, you may see inline version badges:
69
+
For features introduced **after 2.0**, inline version badges may appear in API reference:
70
+
71
+
-`dj.Top()` <spanclass="version-badge">v2.1+</span> - Top N restriction with ordering
0 commit comments