Skip to content

docs: fold 2.3.1 changes into What's New in 2.3 + fix cross-link gaps#206

Merged
dimitri-yatsenko merged 1 commit into
mainfrom
docs/v2.3.1-cohesion
Jul 15, 2026
Merged

docs: fold 2.3.1 changes into What's New in 2.3 + fix cross-link gaps#206
dimitri-yatsenko merged 1 commit into
mainfrom
docs/v2.3.1-cohesion

Conversation

@dimitri-yatsenko

Copy link
Copy Markdown
Member

Release-cohesion pass for v2.3.1, from a full-docs review.

What's New in 2.3 → adds a "Changes in 2.3.1" section

whats-new-23.md described the 2.3 line but had no 2.3.1 delta — a 2.3.0→2.3.1 upgrader wouldn't learn that a feature was removed. Added a Changes in 2.3.1 section covering the user-facing deltas:

  • strict_provenance removed (off-by-default, no known adoption; enforcement moves to review/deploy-time validation; Diagram.trace/self.upstream unchanged).
  • Python 3.14 support (>=3.10,<3.15; CI tests 3.10 + 3.14).
  • Garbage-collection fixgc.collect() now discovers codec-referenced files correctly (closes a path where live custom-codec / <object@> / <npy@> files could be deleted).

Cross-link gaps (from the cohesion review)

  • autopopulate.md — the "fan-out pattern" mention now links to the Fan-Out Ingestion page.
  • computation-model.md "See also" — added Upstream Trace, Fan-Out Ingestion, and Comparison to Provenance Systems.

Deliberately not included

  • mkdocs.yaml datajoint_version is still "2.2". Bumping it to "2.3" is gated on re-executing the tutorial notebooks (the check_notebook_versions.py banner guard would otherwise fail CI), so it belongs with notebook re-execution as a release step rather than this docs PR.

Review scorecard (rest of the docs)

Terminology (lineage vs provenance), strict_provenance cleanup, dangling links, and cross-page coherence (5-rule contract, tripartite signatures, reproducibility≠determinism) all verified clean.

- whats-new-23.md: add a 'Changes in 2.3.1' section (strict_provenance removed,
  Python 3.14 support, codec-driven GC reference-discovery fix) so 2.3.0->2.3.1
  upgraders learn the flag is gone and the range extended.
- autopopulate.md: link the fan-out mention to the Fan-Out Ingestion page.
- computation-model.md: add Upstream Trace, Fan-Out Ingestion, and Comparison to
  Provenance Systems to 'See also'.

Does not touch mkdocs datajoint_version (still '2.2') — bumping it is gated on
re-executing the tutorial notebooks (the version-banner guard), a release step.
@dimitri-yatsenko

Copy link
Copy Markdown
Member Author

@MilagrosMarin — could you take this one? It's the v2.3.1 cohesion follow-up to the review you did on #202/#204: a "Changes in 2.3.1" section on the What's New in 2.3 page (strict_provenance removed, Python 3.14, codec-driven GC fix) plus the two cross-link gaps the review surfaced. Small and self-contained.

@dimitri-yatsenko dimitri-yatsenko merged commit ee58133 into main Jul 15, 2026
2 checks passed
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