fix: preserve paragraphs in recommended spelling descriptions - #399
Merged
hargoniX merged 1 commit intoAug 3, 2026
Merged
Conversation
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
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.
Fixes #398.
Summary
Preserve spaces and paragraph boundaries when rendering multiline
recommended_spellingdescriptions as Verso content.Consecutive non-empty source lines are joined with spaces, while blank lines produce separate paragraphs. Existing behavior for absent and single-line descriptions remains unchanged.
Root cause
The additional information was split into lines and combined using
String.join, which inserts no separator. This concatenated adjacent words and discarded paragraph boundaries.Lean's string representation preserves line breaks and blank lines when generating Markdown. This change mirrors the resulting soft-wrap and paragraph structure using Verso blocks.
Verification
Rendered the reproduction from the linked issue using both the baseline and patched versions of doc-gen4. The Lean input was identical in both builds.
Before
After
Both documentation builds completed successfully with Lean
v4.33.0-rc1, and the generated pages were served locally over HTTP and verified in Chromium.