Skip to content

fix: Strip backslash before # in generated docstrings #677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alan4506 wants to merge 1 commit into
base: develop
Choose a base branch
from
+1 −1
Open

fix: Strip backslash before # in generated docstrings #677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...en/core/src/main/java/software/amazon/smithy/python/codegen/writer/MarkdownConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ private static String postProcessPandocOutput(String output) {
// Remove unnecessary backslash escapes that pandoc adds for markdown
// These characters don't need escaping in Python docstrings
// Handles: [ ] ' { } ( ) < > ` @ _ * | ! ~ $
output = output.replaceAll("\\\\([\\[\\]'{}()<>`@_*|!~$])", "$1");
output = output.replaceAll("\\\\([\\[\\]'{}()<>`@_*|!~$#])", "$1");

// Replace <note> and <important> tags with admonitions for mkdocstrings
output = replaceAdmonitionTags(output, "note", "Note");
Expand Down
Loading