Skip to content
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

Jump to bottom

fix(pacmak/python): escape character escapes in python docs #2138

Merged
merged 8 commits into from Oct 22, 2020
Merged

fix(pacmak/python): escape character escapes in python docs #2138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c236ea6
attempt to escape character escapes
jsteinich Oct 18, 2020
3c0e229
slash seems to be its own node
jsteinich Oct 19, 2020
2f87813
improve needed escape check
jsteinich Oct 19, 2020
6066381
Simplify to always escaping back-slashes
jsteinich Oct 19, 2020
61bb9c7
add some more tests
jsteinich Oct 19, 2020
5c24513
Merge branch 'master' into escape_escapes_in_python_docs
RomainMuller Oct 22, 2020
b71ee19
Merge branch 'master' into escape_escapes_in_python_docs
RomainMuller Oct 22, 2020
dd550e4
Merge branch 'master' into escape_escapes_in_python_docs
mergify[bot] Oct 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/jsii-pacmak/lib/markdown.ts
View file
Open in desktop
Expand Up @@ -20,7 +20,7 @@ export function md2rst(text: string) {
}

function textOf(node: commonmark.Node) {
return node.literal ?? '';
return node.literal?.replace(/\\/g, '\\\\') ?? '';
}

pump(ast, {
Expand Down
17 changes: 17 additions & 0 deletions packages/jsii-pacmak/test/python.test.ts
View file
Open in desktop
Expand Up @@ -113,6 +113,23 @@ test('list with multiline text', () => {
);
});

test('escape character escaping', () => {
converts(
[
String.raw`For example, if you specify "\N", BigQuery interprets "\N" as a null value`,
String.raw`Single slash \\`, // markdown parses the escape even if ts doesn't
String.raw`Double slash \\\\`,
String.raw`Triple slash \\\\\\`,
],
[
String.raw`For example, if you specify "\\N", BigQuery interprets "\\N" as a null value`,
String.raw`Single slash \\`,
String.raw`Double slash \\\\`,
String.raw`Triple slash \\\\\\`,
],
);
});

function converts(input: string[], output: string[]) {
const converted = md2rst(input.join('\n'));

Expand Down