Cut component docs before markup; call out PlantUML in the README - #69
Merged
Merged
Conversation
A component's documentation was truncated after the bold markers and inline-code background tags had been added, so a long javadoc could be cut inside a </back> tag after a line's opening **. PlantUML then printed both literally; ecchronos's SchemaRefresher rendered as "**the scheduler on any managed node; the RepairScheduler</...". The cut now happens on the plain text, at a word boundary, inside StriffComponentDocText (TruncatedText), before any markup exists. An inline-code span the cut passes through is closed instead of left open, and the 800-character budget counts visible characters only. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CxxJyB3tHUxXPxGhnvPjgy
Replaces the old JUnit example with a striff of Ericsson/ecchronos #1786 (NodeWorker handing its repair scheduling to the new SchemaRefresher), rendered by this branch with the default layout. Adds a paragraph near the top saying every striff is a PlantUML class diagram, and bumps the dependency snippet to 4.3.0. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CxxJyB3tHUxXPxGhnvPjgy
Restores the original sample striff image and drops the caption written for the replacement. The PlantUML paragraph and the 4.3.0 dependency snippet stay. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CxxJyB3tHUxXPxGhnvPjgy
Zir0-93
changed the title
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
**bold markers and<back:…>inline-code tags were added, so a long javadoc could be cut inside a</back>tag. PlantUML then printed the broken markup literally (ecchronosSchemaRefresherrendered as**the scheduler on any managed node; the RepairScheduler</...). The cut now happens on the plain text, at a word boundary, in a newTruncatedTextstep ofStriffComponentDocText; an inline-code span it passes through is closed, and the 800-character budget counts visible characters.Test plan
mvn clean package assembly:single(the CI command): 209 tests pass (7 skipped), 0 Checkstyle violationsTextTestcases: a long doc is cut with balanced markup (every line opens and closes**,<back:and</back>counts match, visible length within budget), and a cut through an inline-code span closes the span**and</...inSchemaRefresher) and with this branch (clean cut at "…A table is either...")🤖 Generated with Claude Code
https://claude.ai/code/session_01CxxJyB3tHUxXPxGhnvPjgy