Skip to content

Fix characters interpreted as Smithy format specifiers in doc gen #582

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

Merged
merged 2 commits into from
Oct 22, 2025
Merged

Fix characters interpreted as Smithy format specifiers in doc gen #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed11532
Fix characters interpreted as Smithy format specifiers in doc gen
arandito Oct 21, 2025
add692e
Add unit test
arandito Oct 22, 2025
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
9 changes: 9 additions & 0 deletions ...rc/test/java/software/amazon/smithy/python/aws/codegen/MarkdownToRstDocConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,13 @@ public void testConvertCommonmarkToRstWithNestedList() {
String result = markdownToRstDocConverter.convertCommonmarkToRst(html);
assertEquals(expected, result.trim());
}

@Test
public void testConvertCommonmarkToRstWithFormatSpecifierCharacters() {
// Test that Smithy format specifier characters ($) are properly escaped and treated as literal text
String html = "<html><body><p>Testing $placeholder_one and $placeholder_two</p></body></html>";
String expected = "Testing $placeholder_one and $placeholder_two";
String result = markdownToRstDocConverter.convertCommonmarkToRst(html);
assertEquals(expected, result.trim());
}
}
12 changes: 6 additions & 6 deletions ...src/main/java/software/amazon/smithy/python/codegen/writer/MarkdownToRstDocConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public void head(Node node, int depth) {
if (!text.trim().isEmpty()) {
if (text.startsWith(":param ")) {
int secondColonIndex = text.indexOf(':', 1);
writer.write(text.substring(0, secondColonIndex + 1));
writer.write("$L", text.substring(0, secondColonIndex + 1));
//TODO right now the code generator gives us a mixture of
// RST and HTML (for instance :param xyz: <p> docs
// </p>). Since we standardize to html above, that <p> tag
Expand All @@ -91,16 +91,16 @@ public void head(Node node, int depth) {
} else {
writer.ensureNewline();
writer.indent();
writer.write(text.substring(secondColonIndex + 1));
writer.write("$L", text.substring(secondColonIndex + 1));
writer.dedent();
}
} else {
writer.writeInline(text);
writer.writeInline("$L", text);
}
// Account for services making a paragraph tag that's empty except
// for a newline
} else if (node.parent() != null && ((Element) node.parent()).tagName().equals("p")) {
writer.writeInline(text.replaceAll("[ \\t]+", ""));
writer.writeInline("$L", text.replaceAll("[ \\t]+", ""));
}
} else if (node instanceof Element) {
Element element = (Element) node;
Expand Down Expand Up @@ -158,7 +158,7 @@ public void tail(Node node, int depth) {
case "a":
String href = element.attr("href");
if (!href.isEmpty()) {
writer.writeInline(" <").writeInline(href).writeInline(">`_");
writer.writeInline(" <").writeInline("$L", href).writeInline(">`_");
} else {
writer.writeInline("`");
}
Expand Down Expand Up @@ -196,7 +196,7 @@ public void tail(Node node, int depth) {
break;
case "h1":
String title = element.text();
writer.ensureNewline().writeInline("=".repeat(title.length())).ensureNewline();
writer.ensureNewline().writeInline("$L", "=".repeat(title.length())).ensureNewline();
break;
default:
break;
Expand Down
Loading