docs: fix terminology, core types, and codec examples #126
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
Three documentation fixes for DataJoint 2.0 standards:
inttype with core typeuint16Changes
src/tutorials/advanced/sql-comparison.ipynb# Antijoin:→# Anti-restriction:| Antijoin |→| Anti-restriction |src/tutorials/advanced/custom-codecs.ipynbconn_id : int→conn_id : uint16unit_id : int→unit_id : uint16src/explanation/custom-codecs.mdis_external→is_store(8 instances)return "<hash>"→return "<blob@>"return "<object>"→return "<object@>"src/how-to/create-custom-codec.mdreturn "<hash>"→return "<blob@>"return "<object>"→return "<object@>"Rationale
Terminology (TERMINOLOGY.md)
-operator): Filter rows NOT matching condition&operator): Filter rows matching conditionCore Types (Type System specification)
Core DataJoint types (Layer 2) are preferred:
uint8,uint16,int32,float32— Standardized, portable, explicit sizeint,floatare discouraged — Backend-specific, lack size metadataCodec API (DataJoint 2.0)
is_store(notis_external)<blob@>(not<hash>)<object@>(not<object>)<blob>,bytes,jsonKey Fixes
Storage type corrections:
<hash>was an internal implementation detail, not a public API<blob@>is the correct public API for external blob storage<object@>is required for schema-addressed storage (plain<object>is invalid)Parameter name:
is_storereflects the boolean nature (True = use object store)is_externalwhich was ambiguousVerification
SpikeTrain.unit_id: intcorrectly unchanged (Python type, not DataJoint type)Related