Change MeaningsTable.target from a link to an object-reference attribute - #97
Merged
Conversation
MeaningsTable.target points to a VectorData column of the same DynamicTable
that owns the meanings group. That co-located, within-table-machinery
relationship is the pattern hdmf-common and nwb-schema model with an
object-reference attribute (VectorIndex.target, DynamicTableRegion.table),
not a link. Links are used for shared, standalone objects owned elsewhere in
the file (and possibly in another file). The target here is always a column of
the same table, so the link's only unique capability, cross-file reach, does
not apply.
Reconcile the MeaningsTable docstrings ("linked" -> "referenced") and bump the
hdmf-common namespace to 1.10.0, since this is a breaking change to the 1.9.0
MeaningsTable definition.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
oruebel
approved these changes
Jul 5, 2026
rly
added a commit
to hdmf-dev/hdmf
that referenced
this pull request
Jul 8, 2026
Point the submodule at 4508b8f on main, the squash-merge of hdmf-dev/hdmf-common-schema#97, now that the schema PR is merged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jul 17, 2026
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
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
Changes
MeaningsTable.target(common/table.yaml) from a link to an object-reference attribute (dtypewithreftype: object,target_type: VectorData), matchingVectorIndex.targetandDynamicTableRegion.table.Rationale
hdmf-common and nwb-schema use a consistent heuristic for the two mechanisms:
Device,ImagingPlane, sourceTimeSeries).VectorIndex.target,DynamicTableRegion.table,electrodes.group,ImageReferences).MeaningsTable.targetis the second case: it points to aVectorDatacolumn of the sameDynamicTablethat owns themeaningsgroup. The API in hdmf#1376 already enforces that the target must be a column of that table, so the target is inherently co-located and the link's only unique advantage, cross-file reach, does not apply.VectorIndex.targetis the exact precedent: same target type, same name, same role of annotating a column of the same table, defined as an object reference.The link in #91 was an unexamined default. The hdmf#1376 / #91 discussions were entirely about the
BaseDynamicTableinheritance question; link vs. reference was never raised.Changes
common/table.yaml:MeaningsTable.targetlink -> object-reference attribute; reconcile docstrings ("linked" -> "referenced").common/namespace.yaml: bump hdmf-common to1.10.0.docs/source/hdmf_common_release_notes.rst: add 1.10.0 entry.Notes for reviewers
MeaningsTabledefinition. I bumped the version to1.10.0; adjust if you prefer a different number or want to fold it into a larger release. The release-notes date is left as "Upcoming".Verified the schema loads via HDMF 6.1.0 spec classes:
targetresolves to an attribute with dtype{'target_type': 'VectorData', 'reftype': 'object'}andMeaningsTable.linksis empty.PR checklist for schema changes
docs/source/hdmf_common_release_notes.rst🤖 Generated with Claude Code