feat: allow description line continuation #2048
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
sdghchj
approved these changes
Jul 28, 2025
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.
Describe the PR
This PR adds support for escaping newlines in
@descriptionannotations. This allows for long descriptions to be split across multiple lines in the source code for better readability, without introducing unwanted newlines in the generated Swagger UI.Relation issue
fixes #2047
Additional context
This feature is implemented by introducing a new
AppendDescriptionutility function that handles the concatenation of description lines based on the presence of a trailing backslash.Unit tests for the
AppendDescriptionfunction and an end-to-end test for the line continuation have been added to ensure the correct behavior.