feat: normalize consecutive newlines in markdown descriptions to pres… #542
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
…erve list formatting
|
|
1 task
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.
Related Issue
Fixes #531
Description
This PR addresses a formatting issue where multi-paragraph markdown descriptions inside attribute list items were breaking the surrounding list structure.
In Markdown, two or more consecutive newline characters (\n\n) terminate a list item and start a new paragraph outside the list. This caused multi-line attribute descriptions to appear misaligned or outside of their list items.
To resolve this, the PR introduces a normalization step that collapses multiple consecutive newlines into a hard line break (" \n"). This approach preserves visual line separation while maintaining list integrity across nested and top-level attributes.
The normalization is applied in both
WriteAttributeDescriptionandWriteNestedAttributeTypeDescriptionto ensure consistent behavior across all schema paths.Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
N/A
This PR only modifies Markdown formatting logic in documentation generation.