fix: Strip backslash before ^ in generated docstrings#707
Open
Alan4506 wants to merge 1 commit into
Open
Conversation
arandito
approved these changes
Jun 1, 2026
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
2 participants
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 of changes:
The
MarkdownConverterstrips unnecessary backslash escapes that pandoc adds for markdown syntax characters. However,^was missing from the strip list. When pandoc converts service documentation containing a literal^character, it escapes it to\^because^is a markdown superscript marker in some extensions. This\^then ends up in the generated Python docstring as an invalid escape sequence, causing pyrightreportInvalidStringEscapeSequenceerrors.This issue was identified during generation of DynamoDB client using its model file: one of its
smithy.api#documentationcontains a sequence:<p>4500-6500 third sleep/delay (500 * 2^2)</p>\n.This PR adds
^to the regex character class inpostProcessPandocOutput()so that\^is correctly stripped to^in generated docstrings. This aligns with how we handled a similar issue before in another PR.Verified by generating the DynamoDB client with the fix.
smithy build --autpasses ruff and pyright cleanly, and there is no\^in generated code.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.