docs(test): state test invariants directly instead of citing internal plan refs#233
Merged
Merged
Conversation
… plan refs Why: several merged test files referenced internal planning identifiers and a gitignored planning-doc path in their comments and Javadoc. A public reader of the repo cannot resolve those references, so they read as noise rather than documentation. What: reword the affected comments/Javadoc to describe the invariant or behaviour each test guards, directly: - InlineHighlightRenderTest: the chip-is-one-atomic-token invariant and the over-wide-chip-emitted-on-its-own-line behaviour. - cv + coverletter PresetVisualParityTest: the pixel-diff parity gate now points at its in-source PIXEL_DIFF_BUDGET / PER_PIXEL_TOLERANCE constants, also dropping a stale figure that contradicted them. - VersionConsistencyGuardTest: the version-literal drift class it guards. CanonicalSurfaceGuardTest is intentionally left unchanged — excluding the gitignored planning directory is the behaviour under test there. Tests: ./mvnw test -Dtest=InlineHighlightRenderTest,PresetVisualParityTest,VersionConsistencyGuardTest -pl . (49 passed); ./mvnw -q compile -pl . clean.
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.
Why
Several merged test files referenced internal planning identifiers and a gitignored planning-doc path in their comments and Javadoc. A public reader of the repo cannot resolve those references, so they read as noise rather than documentation.
What changed
Reworded the affected comments/Javadoc to describe the invariant or behaviour each test guards, directly:
InlineHighlightRenderTest— the chip-is-one-atomic-token invariant, and the over-wide-chip-emitted-on-its-own-line behaviour.cv+coverletterPresetVisualParityTest— the pixel-diff parity gate now points at its in-sourcePIXEL_DIFF_BUDGET/PER_PIXEL_TOLERANCEconstants, also dropping a stale figure that contradicted them.VersionConsistencyGuardTest— the version-literal drift class it guards.CanonicalSurfaceGuardTestis intentionally left unchanged — excluding the gitignored planning directory is the behaviour under test there.No production code, public API, or test behaviour changes; comments/Javadoc only.
Verification
./mvnw test -Dtest=InlineHighlightRenderTest,PresetVisualParityTest,VersionConsistencyGuardTest -pl .→ 49 passed, 0 failures../mvnw -q compile -pl .→ clean.