docs: consistent table-tier definitions (Manual = direct insert, not 'by hand')#230
Merged
Merged
Conversation
… not 'by hand') Aligns tutorial and quick-reference tier tables with the authoritative explanation-layer wording (relational-workflow-model.md, autopopulate.md): - Manual: data inserted *directly* from outside the pipeline — by people (forms/GUIs) OR by automated ingestion scripts/instruments — not 'user-entered'/'entered by hand'. The defining property is direct insertion vs. production by make(). - Imported: populated by make() from an external *source* (files, instruments, databases), not only 'files'. - Computed: populated by make() from other tables. Touches quick-ref tables in define-tables.md and table-declaration.md and the tier descriptions in the sql-comparison, calcium-imaging, blob-detection, and 02-schema-design tutorial notebooks.
dimitri-yatsenko
added
the
documentation
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
2 participants
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.
What
Makes the table-tier definitions consistent across the docs. The explanation and reference-spec layers already define the tiers correctly (
explanation/relational-workflow-model.md,reference/specs/autopopulate.md); the tutorials and two quick-reference tables had drifted into describing Manual tables as "user-entered" / "entered by hand," which wrongly excludes automated ingestion.Why
The defining property of a Manual table is that its rows are inserted directly, from outside the DataJoint pipeline — whether typed in by a person (form/GUI) or loaded by an automated ingestion tool/instrument. The contrast that matters is direct insertion vs. production by
make()(Imported/Computed), not human vs. machine authorship. Several tutorial tier-tables stated the human-entry framing as the definition, and a few narrowed Imported to "files" rather than any external source.Changes
make()from an external source (files, instruments, databases)" (no longer "files" only).make()from other tables".Files:
how-to/define-tables.md,reference/specs/table-declaration.md, and the tier tables/legends in thesql-comparison,calcium-imaging,blob-detection, andbasics/02-schema-designtutorial notebooks. Notebook edits are text-only (no re-execution; outputs untouched).Scope note: intentionally left the borderline intro-tutorial phrasings (
01-first-pipeline"you enter data directly,"comparison-to-provenance-systems.md"manual data-entry point") as-is; they keep the correct "directly" framing and rewording adds churn without changing meaning.