Skip to content

What's new in 2.3.4 - #289

Open
dimitri-yatsenko wants to merge 4 commits into
docs/entry-provenancefrom
docs/whats-new-234
Open

dimitri-yatsenko wants to merge 4 commits into
docs/entry-provenancefrom
docs/whats-new-234

Conversation

@dimitri-yatsenko

Copy link
Copy Markdown
Member

Draft release notes for 2.3.4.

Stacked on #288 — it links the two new pages that PR adds, so the base is docs/entry-provenance rather than main. Merging #288 first retargets this automatically. On main alone, mkdocs build --strict fails on the three unresolved links.

What it says

Two bullets in a new Changes in 2.3.4 section, matching the per-patch format the page already uses for 2.3.1–2.3.3:

  • The hidden _prov attribute — what the boundary problem is, that no author writes it, where the content comes from, what makes fan-out traceable, and that tables declared earlier record nothing until dj.deploy.add_prov_column adds the column.
  • The two provenance.* settings, including why capture defaults to on.

The page intro gains the release's shape alongside the diagram and S3 entries already there.

A correction it carries

The 2.3.3 notes say the codec context= parameter replacing the key["_config"] threading is "scheduled ... in 2.3.4", referencing #1550. That issue is now on the v2.3.5 milestone, so the published sentence points at the wrong release. Corrected here, since it is the same page.

Scope caveat

2.3.4's milestone holds two issues. Only #1547 has an implementation (datajoint-python#1555, open). #1546 — the dj.Entry/dj.Ingest/dj.Compute aliases — has no PR yet, so it is deliberately not described here; the aliases are mentioned only in the new spec's version-added note, which #288 carries. Add a bullet for them when that lands, or move the issue off the milestone.

Nothing here should merge before datajoint-python#1555 does — these notes describe behavior that is not on master yet.

Verification

mkdocs build --strict clean and check_links.py passes across 144 pages on the stacked base.

Adds the 2.3.4 section to the 2.3 release notes, covering the hidden `_prov`
attribute and the two provenance settings, and names the release's shape in
the page intro.

Also corrects a forward reference the 2.3.3 notes carried: the codec
`context=` parameter that replaces the `key["_config"]` threading was said to
be scheduled for 2.3.4, but #1550 now sits on the 2.3.5 milestone.
#1550 moves onto the 2.3.4 milestone, so the 2.3.3 forward reference is
correct again and the release gains a bullet of its own. The bullet leads on
what the argument is for and states plainly that codecs written before 2.3.4
keep working, since that is the first question a codec author will have.
Two user-visible changes in the milestone were missing from the notes.

`dj.Entry`, `dj.Ingest` and `dj.Compute` are permanent aliases, verified as
the same classes rather than subclasses, so nothing about `describe()` or the
diagram changes.

The platform-column refactor is a fix, not only tidying: on PostgreSQL
`_job_start_time` had microsecond precision where MySQL had millisecond, and
the job-metadata retrofit had never run there at all.

This branch has not been deployed

No deployments
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.

1 participant