Fix characters interpreted as Smithy format specifiers in doc gen #582
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.
Description
Fixed an issue in doc string generation where special characters (specifically $) in the Smithy model's documentation traits were being incorrectly interpreted as Smithy format specifiers (docs).
The fix adds the
$Lformatter towrite()andwriteInline()calls inMarkdownToRstDocConverter.java, ensuring doc strings are treated as string literals rather than as format expressions. This prevents the unintended interpolation of doc strings that contain characters like $.Testing
Successfully rebuilt
aws-sdk-bedrock-runtimeclient and ensured no changes were reflected in docstrings.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.