docs(cv-v2): fix two stale Javadoc references from migration review#67
Merged
Conversation
…view * CvSpacing.monogramSidebar() Javadoc claimed the preset "draws its visual chrome inline (... filler shape)" — stale. MonogramSidebar paints the sidebar fill via DocumentSession.pageBackgrounds(...) on every page; the filler shape was removed. Reworded to describe the pageBackgrounds chrome accurately. * PanelSmokeTest Javadoc @link'd SectionDispatcher, but Panel renders its own row-free body dispatcher (cards sit inside flow.addRow, which the engine forbids from containing nested rows). Updated the doc to describe the preset-local dispatcher and the reason. Comment-only — no behaviour or render change.
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
Two doc-only fixes surfaced by the
graphcompose-cv-v2-migration-reviewaudit of the 6 migrated CV v2 presets. No behaviour or render change.CvSpacing.monogramSidebar()— Javadoc claimed the preset "draws its visual chrome inline (… filler shape)". Stale: MonogramSidebar now paints the sidebar fill viaDocumentSession.pageBackgrounds(...)on every page and the filler shape was removed. Reworded to describe the pageBackgrounds chrome.PanelSmokeTest— Javadoc@link'dSectionDispatcher, but Panel renders a preset-local row-free dispatcher (its cards sit insideflow.addRow, which the engine forbids from containing nested rows). Updated to describe the preset-local dispatcher + reason.Review context
The full migration review (Executive / Panel / TimelineMinimal / EngineeringResume / MonogramSidebar / SidebarPortrait) came back 0 FAILs. These were the only two actionable WARNs (both stale comments). Remaining WARNs are documented design trade-offs (atomic
flow.addRowsingle-page constraint, TimelineMinimal fixed-height axis) and a deferred size optimisation (SidebarPortrait 945 lines).Test plan
./mvnw test -Dtest=PanelSmokeTest,MonogramSidebarSmokeTest -pl .— pass (compile + smoke)