Skip to content

Commit a7b389e

Browse files
committed
Update documentation
1 parent 5adfcf5 commit a7b389e

9 files changed

Lines changed: 160 additions & 158 deletions

File tree

about/whats-new-23/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6524,6 +6524,7 @@ <h2 id="changes-in-232">Changes in 2.3.2<a class="headerlink" href="#changes-in-
65246524
<li><strong>Uncaught exceptions show full tracebacks again.</strong> Importing <code>datajoint</code> no longer installs a process-wide <code>sys.excepthook</code>. Previously any uncaught exception in the process — DataJoint-related or not — was reduced to a single opaque <code>[ERROR]: Uncaught exception</code> line with no type, message, or traceback; now Python's default handler prints the full traceback to stderr. The log formatter also renders exception and stack info correctly. See <a href="https://github.com/datajoint/datajoint-python/issues/1516">#1516</a>.</li>
65256525
<li><strong><code>populate(reserve_jobs=True)</code> works with <code>uuid</code>-derived primary keys.</strong> Auto-populating a <code>Computed</code>/<code>Imported</code> table whose primary key derives from a <code>uuid</code> attribute no longer crashes with <code>Unsupported attribute type binary(16)</code> when its jobs table is first created. See <a href="https://github.com/datajoint/datajoint-python/issues/1515">#1515</a>.</li>
65266526
<li><strong>Safer garbage collection.</strong> <code>gc.collect()</code> no longer acts on a partial store listing, closing a path where an interrupted or incomplete storage enumeration could misclassify live files as orphans. See <a href="../../how-to/garbage-collection/">Clean Up Object Storage</a>.</li>
6527+
<li><strong>Clearer diagram notation for renamed foreign keys.</strong> A renamed (aliased) foreign key now renders as a distinctly colored <strong>orange edge</strong> — with a hover tooltip listing the renamed columns (e.g. <code>spouse1 ← person_id</code>) — instead of the small orange <strong>alias dot</strong> used previously. Orange layers on top of the existing line styles (solid/dashed for primary/secondary, thick for one-to-one), so the foreign-key kind stays legible. Internally the dependency graph is now an <code>nx.MultiDiGraph</code> with parallel edges rather than alias nodes; behavior is unchanged. See <a href="../../how-to/read-diagrams/">Read Diagrams</a>.</li>
65276528
<li><strong>Version derived from the release tag.</strong> The package version now comes from the git tag (via <code>hatch-vcs</code>), so a git install of a tagged commit (<code>pip install "git+https://github.com/datajoint/datajoint-python.git@v2.3.2"</code>) and <code>pip show datajoint</code> both report <code>2.3.2</code> — previously such an install could report the prior release. Running from an uninstalled source tree now reports <code>0.0.0+unknown</code>; use <code>pip install -e .</code> for development.</li>
65286529
</ul>
65296530
<h2 id="changes-in-231">Changes in 2.3.1<a class="headerlink" href="#changes-in-231" title="Permanent link">&para;</a></h2>

how-to/demo_modules/__init__/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3308,7 +3308,7 @@ <h1> init </h1>
33083308
</style>
33093309
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
33103310
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
3311-
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=9b195af6">
3311+
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=0df5d377">
33123312
<div class="jp-Cell-inputWrapper" tabindex="0">
33133313
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33143314
</div>

how-to/demo_modules/acquisition/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3309,7 +3309,7 @@ <h1>Acquisition</h1>
33093309
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
33103310
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
33113311
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3312-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=3ba3e0dc">
3312+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=db5404d2">
33133313
<div class="jp-Cell-inputWrapper" tabindex="0">
33143314
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33153315
</div>
@@ -3348,7 +3348,7 @@ <h1>Acquisition</h1>
33483348
</div>
33493349
</div>
33503350
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3351-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=4c2b4e0f">
3351+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=206e82b4">
33523352
<div class="jp-Cell-inputWrapper" tabindex="0">
33533353
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33543354
</div>
@@ -3377,7 +3377,7 @@ <h1>Acquisition</h1>
33773377
</div>
33783378
</div>
33793379
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3380-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=32168323">
3380+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e3216214">
33813381
<div class="jp-Cell-inputWrapper" tabindex="0">
33823382
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33833383
</div>
@@ -3416,7 +3416,7 @@ <h1>Acquisition</h1>
34163416
</div>
34173417
</div>
34183418
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3419-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=8a4af2c4">
3419+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=2e8c293c">
34203420
<div class="jp-Cell-inputWrapper" tabindex="0">
34213421
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34223422
</div>
@@ -3459,7 +3459,7 @@ <h1>Acquisition</h1>
34593459
</div>
34603460
</div>
34613461
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3462-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=64ecfc6d">
3462+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=2bb74cf4">
34633463
<div class="jp-Cell-inputWrapper" tabindex="0">
34643464
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34653465
</div>

how-to/demo_modules/analysis/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3309,7 +3309,7 @@ <h1>Analysis</h1>
33093309
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
33103310
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
33113311
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3312-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=126ab2e7">
3312+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c27ca0de">
33133313
<div class="jp-Cell-inputWrapper" tabindex="0">
33143314
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33153315
</div>
@@ -3350,7 +3350,7 @@ <h1>Analysis</h1>
33503350
</div>
33513351
</div>
33523352
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3353-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=6057def3">
3353+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=3f98254f">
33543354
<div class="jp-Cell-inputWrapper" tabindex="0">
33553355
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33563356
</div>
@@ -3379,7 +3379,7 @@ <h1>Analysis</h1>
33793379
</div>
33803380
</div>
33813381
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3382-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=daf5a9d1">
3382+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=79b586e8">
33833383
<div class="jp-Cell-inputWrapper" tabindex="0">
33843384
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33853385
</div>
@@ -3420,7 +3420,7 @@ <h1>Analysis</h1>
34203420
</div>
34213421
</div>
34223422
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3423-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=bfb866d1">
3423+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=45821e93">
34243424
<div class="jp-Cell-inputWrapper" tabindex="0">
34253425
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34263426
</div>
@@ -3469,7 +3469,7 @@ <h1>Analysis</h1>
34693469
</div>
34703470
</div>
34713471
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3472-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=4a66ebf1">
3472+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=97a9fe91">
34733473
<div class="jp-Cell-inputWrapper" tabindex="0">
34743474
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34753475
</div>

how-to/demo_modules/processing/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3309,7 +3309,7 @@ <h1>Processing</h1>
33093309
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
33103310
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
33113311
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3312-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=b859d5c9">
3312+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1284e8e7">
33133313
<div class="jp-Cell-inputWrapper" tabindex="0">
33143314
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33153315
</div>
@@ -3350,7 +3350,7 @@ <h1>Processing</h1>
33503350
</div>
33513351
</div>
33523352
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3353-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c8ee3fc2">
3353+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=569fbdac">
33543354
<div class="jp-Cell-inputWrapper" tabindex="0">
33553355
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33563356
</div>
@@ -3379,7 +3379,7 @@ <h1>Processing</h1>
33793379
</div>
33803380
</div>
33813381
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3382-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=bdbaea51">
3382+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=b7a99b24">
33833383
<div class="jp-Cell-inputWrapper" tabindex="0">
33843384
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
33853385
</div>
@@ -3422,7 +3422,7 @@ <h1>Processing</h1>
34223422
</div>
34233423
</div>
34243424
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3425-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=f93dc958">
3425+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=6f987be6">
34263426
<div class="jp-Cell-inputWrapper" tabindex="0">
34273427
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34283428
</div>
@@ -3471,7 +3471,7 @@ <h1>Processing</h1>
34713471
</div>
34723472
</div>
34733473
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3474-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=47fb33be">
3474+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=49b6051b">
34753475
<div class="jp-Cell-inputWrapper" tabindex="0">
34763476
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
34773477
</div>

llms-full.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DataJoint Documentation (Full)
22

3-
Generated: 2026-07-21 23:50:32 UTC
3+
Generated: 2026-07-22 20:00:51 UTC
44
Commit: unknown
55
Branch: unknown
66

@@ -39868,6 +39868,7 @@ DataJoint 2.3 adds a first-class **upstream read surface** — `Diagram.trace` a
3986839868
- **Uncaught exceptions show full tracebacks again.** Importing `datajoint` no longer installs a process-wide `sys.excepthook`. Previously any uncaught exception in the process — DataJoint-related or not — was reduced to a single opaque `[ERROR]: Uncaught exception` line with no type, message, or traceback; now Python's default handler prints the full traceback to stderr. The log formatter also renders exception and stack info correctly. See [#1516](https://github.com/datajoint/datajoint-python/issues/1516).
3986939869
- **`populate(reserve_jobs=True)` works with `uuid`-derived primary keys.** Auto-populating a `Computed`/`Imported` table whose primary key derives from a `uuid` attribute no longer crashes with `Unsupported attribute type binary(16)` when its jobs table is first created. See [#1515](https://github.com/datajoint/datajoint-python/issues/1515).
3987039870
- **Safer garbage collection.** `gc.collect()` no longer acts on a partial store listing, closing a path where an interrupted or incomplete storage enumeration could misclassify live files as orphans. See [Clean Up Object Storage](../how-to/garbage-collection.md).
39871+
- **Clearer diagram notation for renamed foreign keys.** A renamed (aliased) foreign key now renders as a distinctly colored **orange edge** — with a hover tooltip listing the renamed columns (e.g. `spouse1 ← person_id`) — instead of the small orange **alias dot** used previously. Orange layers on top of the existing line styles (solid/dashed for primary/secondary, thick for one-to-one), so the foreign-key kind stays legible. Internally the dependency graph is now an `nx.MultiDiGraph` with parallel edges rather than alias nodes; behavior is unchanged. See [Read Diagrams](../how-to/read-diagrams.ipynb).
3987139872
- **Version derived from the release tag.** The package version now comes from the git tag (via `hatch-vcs`), so a git install of a tagged commit (`pip install "git+https://github.com/datajoint/datajoint-python.git@v2.3.2"`) and `pip show datajoint` both report `2.3.2` — previously such an install could report the prior release. Running from an uninstalled source tree now reports `0.0.0+unknown`; use `pip install -e .` for development.
3987239873

3987339874
## Changes in 2.3.1

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)