docs(pj_scene_protocol): point at sibling ARCHITECTURE.md, not pj_media#82
Merged
facontidavide merged 1 commit intomainfrom May 5, 2026
Merged
Conversation
The schema-spec headers used to point at `pj_media/docs/datatypes_2D.md §8` for the canonical type catalog, dating from when this module lived inside PJ4's pj_media tree. After the relocation in #81, that PJ4 doc was rewritten to point AT pj_scene_protocol/docs/ARCHITECTURE.md — making the header cross-reference circular. Both header comments now point at the sibling docs/ARCHITECTURE.md. Drops the residual `pj_media`-specific phrasing from scene_decoder.h's class comment. Co-Authored-By: Claude Opus 4.7 (1M context) <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
1 participant
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
The schema-spec headers were left pointing at
pj_media/docs/datatypes_2D.md §8for the canonical type catalog — a holdover from when this module lived inside PJ4'spj_media/tree. After the relocation in #81, that PJ4 doc was rewritten to point ATpj_scene_protocol/docs/ARCHITECTURE.md, making the header cross-reference circular.This PR redirects the two header comments to the sibling
docs/ARCHITECTURE.md(the authoritative spec) and drops some residualpj_media-specific phrasing inscene_decoder.h.Changes
include/pj_scene_protocol/image_annotation.h—AnnotationTopologydoc comment now points atdocs/ARCHITECTURE.md.include/pj_scene_protocol/scene_decoder.h—ISceneDecoderdoc comment points atdocs/ARCHITECTURE.mdand replaces "invisible to pj_media" with "invisible to consumers of this module" (this module shouldn't name a specific consumer).No code change. 44/44 tests still pass.
Test plan
./build.shclean./test.sh— 44/44 (image_annotation_codec_test, scene_decoder_test included)🤖 Generated with Claude Code