docs: Fix terminology inconsistencies#134
Merged
dimitri-yatsenko merged 2 commits intodatajoint:mainfrom Jan 22, 2026
Merged
Conversation
- Fix `is_external` → `is_store` parameter name in codec examples (8 instances) - Fix `path-addressed` → `schema-addressed` terminology (3 instances) - Add missing how-to guides to mkdocs.yaml navigation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
dimitri-yatsenko
requested changes
Jan 22, 2026
Member
dimitri-yatsenko
left a comment
dimitri-yatsenko
left a comment
There was a problem hiding this comment.
Review
The terminology fixes (is_external → is_store and path-addressed → schema-addressed) are correct and needed. ✅
However, the mkdocs.yaml changes will break the build. The PR adds navigation entries for files that don't exist:
how-to/manage-secrets.md❌how-to/object-storage-overview.md❌how-to/choose-storage-type.md❌
Options:
- Remove the mkdocs.yaml changes from this PR and submit them separately when the files are created
- Create stub files for these how-to guides in this PR
I recommend option 1 — keep this PR focused on the terminology fixes.
Per reviewer feedback, removing mkdocs.yaml nav entries for files that don't exist yet: - how-to/manage-secrets.md - how-to/object-storage-overview.md - how-to/choose-storage-type.md These can be added in a future PR when the content is created. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Collaborator
Author
|
Thanks for the thorough review @dimitri-yatsenko! I've addressed the feedback in commit dcb12f8: ✅ Removed nav entries for non-existent files:
The PR now focuses only on the terminology fixes ( Let me know if anything else needs adjustment! |
MilagrosMarin
changed the title
dimitri-yatsenko
approved these changes
Jan 22, 2026
Member
dimitri-yatsenko
left a comment
dimitri-yatsenko
left a comment
There was a problem hiding this comment.
Review ✅
Approved. My previous review was in error — the how-to files do exist.
All changes look good:
is_external→is_store— Correctly matches datajoint-python source code ✅path-addressed→schema-addressed— Completes terminology standardization ✅- mkdocs.yaml navigation — Adds existing files to sidebar ✅
Ready to merge.
MilagrosMarin
added a commit
to MilagrosMarin/datajoint-docs
that referenced
this pull request
Jan 22, 2026
Restores navigation entries that were incorrectly removed in PR datajoint#134: - how-to/manage-secrets.md → Setup section - how-to/object-storage-overview.md → Object Storage section - how-to/choose-storage-type.md → Object Storage section These files exist but were missing from the sidebar navigation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2 tasks
dimitri-yatsenko
pushed a commit
that referenced
this pull request
Jan 22, 2026
Restores navigation entries that were incorrectly removed in PR #134: - how-to/manage-secrets.md → Setup section - how-to/object-storage-overview.md → Object Storage section - how-to/choose-storage-type.md → Object Storage section These files exist but were missing from the sidebar navigation. Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
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.
Summary
is_external→is_storeparameter name in codec examples to match source codepath-addressed→schema-addressedterminology rename (missed in PR docs: Enhance type system diagram and storage terminology #132)Changes
Codec Parameter Name (
is_external→is_store)The source code (
datajoint-pythonpre/v2.1) usesis_store: boolbut docs hadis_external:src/explanation/type-system.md— GraphCodec examplesrc/reference/specs/type-system.md— FilepathCodec, BlobCodec, AttachCodec examples (8 instances total)Terminology (
path-addressed→schema-addressed)PR #132 renamed this terminology but missed 3 instances:
src/explanation/faq.md— Object storage addressing modessrc/how-to/use-object-storage.md— Storage type guidancesrc/how-to/define-tables.md— Object type descriptionsTest plan
🤖 Generated with Claude Code