Skip to content

docs(provenance): soften 'guarantee' to 'property' for make() contract#214

Merged
MilagrosMarin merged 1 commit into
datajoint:mainfrom
MilagrosMarin:docs/provenance-property-wording
Jul 17, 2026
Merged

docs(provenance): soften 'guarantee' to 'property' for make() contract#214
MilagrosMarin merged 1 commit into
datajoint:mainfrom
MilagrosMarin:docs/provenance-property-wording

Conversation

@MilagrosMarin

@MilagrosMarin MilagrosMarin commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Small terminology tweak in comparison-to-provenance-systems.md:41.

The surrounding section — "Lineage as a structural property" — argues that lineage is FK-graph-shaped (framework-enforced). The make() reproducibility contract at autopopulate.md:322, on the other hand, explicitly frames itself as "a convention — observed by discipline, not enforced."

Calling both the same "guarantee" in one sentence quietly conflates FK integrity (a real framework guarantee) with the make() contract (an author-observed convention). Swap to "property" — thematically consistent with the section title, no overpromise.

The make() reproducibility contract is framed at autopopulate.md:322 as
'a convention — observed by discipline, not enforced.' Calling it a
'guarantee' alongside the framework-enforced FK integrity quietly
conflates the two.

One-word swap: 'the same guarantee' -> 'the same property'. Consistent
with the section title 'Lineage as a structural property'.

@dimitri-yatsenko dimitri-yatsenko left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. 'property' is the better word here; no accuracy concern.

@MilagrosMarin
MilagrosMarin merged commit 9225efe into datajoint:main Jul 17, 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